feat(gcode_shell_command): allowing for expanding env vars (#747)

allowing for expanding env vars

.editorconfig

@@ -11,5 +11,5 @@ end_of_line = lf
 [*.py]
 max_line_length = 88
 
-[*.sh]
+[*.{sh,yml,yaml,json}]
 indent_size = 2

.github/workflows/release-ff-and-tag.yml

@@ -0,0 +1,33 @@
+name: Release - Fast-Forward and Tag
+on:
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: 'Provide a tag name (e.g. v1.0.0)'
+        required: true
+        type: string
+
+jobs:
+  ff-and-tag:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: 'master'
+      - name: Merge Fast Forward
+        uses: MaximeHeckel/github-action-merge-fast-forward@v1.1.0
+        with:
+          branchtomerge: origin/develop
+          branch: master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create and Push Tag
+        run: |
+          git tag ${{ inputs.tag_name }}
+          git push origin ${{ inputs.tag_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,8 +1,13 @@
 .idea
 .vscode
 .pytest_cache
+.jupyter
+*.ipynb
+*.ipynb_checkpoints
+*.tmp
 __pycache__
 .kiauh-env
 *.code-workspace
 *.iml
 kiauh.cfg
+klipper_repos.txt

.shellcheckrc

@@ -1,15 +0,0 @@
-source=scripts
-
-enable=avoid-nullary-conditions
-enable=deprecate-which
-enable=quote-safe-variables
-enable=require-variable-braces
-enable=require-double-brackets
-
-# SC2162: `read` without `-r` will mangle backslashes.
-# https://github.com/koalaman/shellcheck/wiki/SC2162
-disable=SC2162
-
-# SC2164: Use `cd ... || exit` in case `cd` fails
-# https://github.com/koalaman/shellcheck/wiki/SC2164
-disable=SC2164

README.md

@@ -1,8 +1,6 @@
 <p align="center">
-  <a>
-    <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
+    <img src="docs/assets/logo-large.png" alt="KIAUH Logo" height="181">
     <h1 align="center">Klipper Installation And Update Helper</h1>
-  </a>
 </p>
 
 <p align="center">
@@ -27,48 +25,68 @@
 </h2>
 
 ### 📋 Prerequisites
-KIAUH is a script that assists you in installing Klipper on a Linux operating system that has
-already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure 
-that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image 
-if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/) 
+
+KIAUH is a script that assists you in installing Klipper on a Linux operating
+system that has
+already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a
+result, you must ensure
+that you have a functional Linux system on hand.
+`Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image
+if you are using a Raspberry Pi.
+The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/)
 is the simplest way to flash an image like this to an SD card.
 
 * Once you have downloaded, installed and launched the Raspberry Pi Imager,
   select `Choose OS -> Raspberry Pi OS (other)`: \
+
 <p align="center">
-  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
+  <img src="docs/assets/rpi_imager1.png" alt="KIAUH logo" height="350">
 </p>
 
-* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that instead):
+* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that
+  instead):
+
 <p align="center">
-  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
+  <img src="docs/assets/rpi_imager2.png" alt="KIAUH logo" height="350">
 </p>
 
-* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which 
+* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card
+  to which
   you want to flash the image.
 
-* Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu)
+* Make sure to go into the Advanced Option (the cog icon in the lower left
+  corner of the main menu)
   and enable SSH and configure Wi-Fi.
 
-* If you need more help for using the Raspberry Pi Imager, please visit the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
+* If you need more help for using the Raspberry Pi Imager, please visit
+  the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
 
-These steps **only** apply if you are actually using a Raspberry Pi. In case you want 
-to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed 
-to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run 
-and operate on the Linux Distribution you are going to flash. You likely will have the most success with
-distributions based on Debian 11 Bullseye. Read the notes further down below in this document.
+These steps **only** apply if you are actually using a Raspberry Pi. In case you
+want
+to use a different SBC (like an Orange Pi or any other Pi derivates), please
+look up on how to get an appropriate Linux image flashed
+to the SD card before proceeding further (usually done with Balena Etcher in
+those cases). Also make sure that KIAUH will be able to run
+and operate on the Linux Distribution you are going to flash. You likely will
+have the most success with
+distributions based on Debian 11 Bullseye. Read the notes further down below in
+this document.
 
 ### 💾 Download and use KIAUH
+
 **📢 Disclaimer: Usage of this script happens at your own risk!**
 
 * **Step 1:** \
-To download this script, it is necessary to have git installed. If you don't have git already installed, or if you are unsure, run the following command:
+  To download this script, it is necessary to have git installed. If you don't
+  have git already installed, or if you are unsure, run the following command:
+
 ```shell
 sudo apt-get update && sudo apt-get install git -y
 ```
 
 * **Step 2:** \
-Once git is installed, use the following command to download KIAUH into your home-directory:
+  Once git is installed, use the following command to download KIAUH into your
+  home-directory:
 
 ```shell
 cd ~ && git clone https://github.com/dw-0/kiauh.git
@@ -82,26 +100,31 @@ Finally, start KIAUH by running the next command:
 ```
 
 * **Step 4:** \
-You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending 
-on what you want to do. To choose an action, simply type the corresponding number into the "Perform action" 
+  You should now find yourself in the main menu of KIAUH. You will see several
+  actions to choose from depending
+  on what you want to do. To choose an action, simply type the corresponding
+  number into the "Perform action"
   prompt and confirm by hitting ENTER.
 
 <hr>
 
 <h2 align="center">❗ Notes ❗</h2>
 
-### **📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
+### **📋 Please see the [Changelog](docs/changelog.md) for possible important
+
+changes!**
 
 - Mainly tested on Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye)
     - Other Debian based distributions (like Ubuntu 20 to 22) likely work too
     - Reported to work on Armbian as well but not tested in detail
-- During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.
+- During the use of this script you will be asked for your sudo password. There
+  are several functions involved which need sudo privileges.
 
 <hr>
 
 <h2 align="center">🌐 Sources & Further Information</h2>
 
-<table>
+<table align="center">
 <tr>
     <th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
     <th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
@@ -117,6 +140,7 @@ prompt and confirm by hitting ENTER.
     <th>by <a href="https://github.com/Arksine">Arksine</a></th>
     <th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
 </tr>
+
 <tr>
     <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
     <th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
@@ -138,13 +162,11 @@ prompt and confirm by hitting ENTER.
     <th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
     <th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
 </tr>
-
 <tr>
     <th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
     <th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
     <th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
 </tr>
-
 <tr>
     <th>by <a href="https://github.com/nlef">nlef</a></th>
     <th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
@@ -155,23 +177,30 @@ prompt and confirm by hitting ENTER.
     <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
     <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
     <th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
-<th><h3></h3></th>
 </tr>
-
 <tr>
-<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="OctoEverywhere Logo" height="64"></a></th>
+    <th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
     <th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
     <th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
 </tr>
-
 <tr>
     <th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
     <th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
     <th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
-<th></th>
 </tr>
 
-
+<tr>
+    <th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
+    <th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
+    <th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
+</tr>
+<tr>
+    <th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
+    <th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
+</tr>
 </table>
 
 <hr>
@@ -186,15 +215,25 @@ prompt and confirm by hitting ENTER.
 
 <hr>
 
-<h2 align="center">✨ Credits ✨</h2>
-
-* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!
-* Also, a big thank you to everyone who supported my work with a [Ko-fi](https://ko-fi.com/dw__0) !
-* Last but not least: Thank you to all contributors and members of the Klipper Community who like and share this project!
+<div align="center">
+    <img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
+</div>
 
 <hr>
 
-<h4 align="center">A special thank you to JetBrains for sponsoring this project with their incredible software!</h4>
+<h2 align="center">✨ Credits ✨</h2>
+
+* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome
+  KIAUH-Logo!
+* Also, a big thank you to everyone who supported my work with
+  a [Ko-fi](https://ko-fi.com/dw__0) !
+* Last but not least: Thank you to all contributors and members of the Klipper
+  Community who like and share this project!
+
+<hr>
+
+<h4 align="center">A special thank you to JetBrains for sponsoring this project
+with their incredible software!</h4>
 <p align="center">
   <a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
     <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">

README_zh.md

@@ -0,0 +1,206 @@
+# KIAUH - Klipper 安装与更新助手
+
+<p align="center">
+  <a>
+    <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
+    <h1 align="center">Klipper Installation And Update Helper</h1>
+  </a>
+</p>
+
+<p align="center">
+  一个方便的安装脚本，让安装Klipper（以及更多组件）变得轻松！
+</p>
+
+<p align="center">
+  <a><img src="https://img.shields.io/github/license/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/stars/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/forks/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash&logoColor=white"></a>
+  <a><img src="https://img.shields.io/github/v/tag/dw-0/kiauh"></a>
+  <br />
+  <a><img src="https://img.shields.io/github/last-commit/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/contributors/dw-0/kiauh"></a>
+</p>
+
+## 📄 使用说明
+
+### 📋 系统要求
+KIAUH 是一个帮助您在 Linux 系统上安装 Klipper 的脚本工具，
+它需要一个已经写入树莓派（或其他单板计算机）SD 卡的 Linux 系统。
+如果您使用树莓派，推荐使用 `Raspberry Pi OS Lite (32位或64位)` 系统镜像。
+[官方 Raspberry Pi Imager](https://www.raspberrypi.com/software/) 是将此类镜像写入 SD 卡的最简单方式。
+
+* 下载、安装并启动 Raspberry Pi Imager 后，
+选择 `Choose OS -> Raspberry Pi OS (other)`:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
+</p>
+
+* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
+</p>
+
+* 返回 Raspberry Pi Imager 主界面，选择对应的 SD 卡作为写入目标。
+
+* 确保点击左下角的齿轮图标（在主菜单中）
+启用 SSH 并配置 Wi-Fi。
+
+* 如果您需要更多关于使用 Raspberry Pi Imager 的帮助，请访问 [官方文档](https://www.raspberrypi.com/documentation/computers/getting-started.html)。
+
+这些步骤**仅适用于**您实际使用树莓派的情况。如果您想使用其他单板计算机（如香橙派或其他 Pi 衍生产品），
+请查找如何将合适的 Linux 镜像写入 SD 卡（通常使用 Balena Etcher）。
+同时确保 KIAUH 能够在您要安装的 Linux 发行版上运行。
+您在使用基于 Debian 11 Bullseye 的系统时可能会获得最佳体验。
+请阅读本文档下方的注意事项。
+
+### 💾 下载并使用 KIAUH
+
+**📢 免责声明：使用此脚本的风险由您自行承担！**
+
+* **第一步：**
+要下载此脚本，需要先安装 git。
+如果您不确定是否已安装 git，请运行以下命令：
+```shell
+sudo apt-get update && sudo apt-get install git -y
+```
+
+* **第二步：**
+安装完 git 后，
+使用以下命令将 KIAUH 下载到您的主目录：
+
+```shell
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
+
+* **第三步：**
+最后，通过运行以下命令启动 KIAUH：
+
+```shell
+./kiauh/kiauh.sh
+```
+
+* **第四步：**
+您现在应该会看到 KIAUH 的主菜单。
+根据您的选择，
+您会看到几个可选操作。
+要选择某个操作，只需在 "Perform action" 提示后输入对应的数字并按回车键确认。
+
+## ❗ 注意事项
+
+### **📋 请查看 [更新日志](docs/changelog.md) 以了解可能的重要更新！**
+
+- 主要在 Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye) 上测试
+    - 其他基于 Debian 的发行版（如 Ubuntu 20 到 22）也可能正常工作
+    - 据报告在 Armbian 上也可用，但未进行详细测试
+- 在使用此脚本的过程中，
+您会被要求输入 sudo 密码。
+因为有几个功能需要 sudo 权限。
+
+## 🌐 相关资源与更多信息
+
+<table align="center">
+<tr>
+    <th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
+    <th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
+    <th>由 <a href="https://github.com/Arksine">Arksine</a></th>
+    <th>由 <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
+    <th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
+    <th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+    <th>由 <a href="https://github.com/jordanruthe">jordanruthe</a></th>
+    <th>由 <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
+    <th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/nlef">nlef</a></th>
+    <th>由 <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+    <th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
+    <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
+    <th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
+    <th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
+    <th>由 <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+    <th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
+    <th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
+    <th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
+    <th>由 <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
+</tr>
+</table>
+
+## 🎖️ 贡献者
+
+<div align="center">
+  <a href="https://github.com/dw-0/kiauh/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
+  </a>
+</div>
+
+<div align="center">
+    <img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
+</div>
+
+## ✨ 特别感谢
+
+* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志！
+* 同时，非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人！
+* 最后但同样重要的是：感谢所有为 Klipper 社区做出贡献的成员，以及喜欢和分享这个项目的朋友们！
+
+<h4 align="center">特别感谢 JetBrains 为本项目提供其出色的软件赞助！</h4>
+<p align="center">
+  <a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
+    <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
+  </a>
+</p>

default.kiauh.cfg

@@ -2,17 +2,35 @@
 backup_before_update: False
 
 [klipper]
-repo_url: https://github.com/Klipper3d/klipper
-branch: master
+# add custom repositories here, if at least one is given, the first in the list will be used by default
+# otherwise the official repository is used
+#
+# format: https://github.com/username/repository, branch
+# example: https://github.com/Klipper3d/klipper, master
+#
+# branch is optional, if given, it must be preceded by a comma, if not given, 'master' is used
+repositories:
+    https://github.com/Klipper3d/klipper
 
 [moonraker]
-repo_url: https://github.com/Arksine/moonraker
-branch: master
+# Moonraker supports two optional Python packages that can be used to reduce its CPU load
+# If set to true, those packages will be installed during the Moonraker installation
+optional_speedups: True
+
+# add custom repositories here, if at least one is given, the first in the list will be used by default
+# otherwise the official repository is used
+#
+# format: https://github.com/username/repository, branch
+# example: https://github.com/Arksine/moonraker, master
+#
+# branch is optional, if given, it must be preceded by a comma, if not given, 'master' is used
+repositories:
+    https://github.com/Arksine/moonraker
 
 [mainsail]
 port: 80
 unstable_releases: False
 
 [fluidd]
-port: 81
+port: 80
 unstable_releases: False

docs/changelog.md

@@ -2,27 +2,64 @@
 
 This document covers possible important changes to KIAUH.
 
+### 2025-10-10 (v6.0.0)
+
+KIAUH has now reached version 6! The majority of the changes mentioned in the
+previous changelog are now available in the final version.
+Most notible are the following changes:
+
+- The dialog for selecting between v5 and v6 is gone and all v5 code was
+  removed. V6 is the new default
+- You can add/remove alternative repositories for Klipper and Moonraker from
+  within KIAUH, no need to manually edit any file
+- You can store and load firmware configurations for Klipper during the firmware
+  compilation process
+- Spoolman is available as an extension, it does not use the bare-metal
+  installation anymore, instead it uses the Docker Container approach
+- OctoApp is available as an extension
+- OctoPrint support was NOT killed. OctoPrint is available as an extension
+- I probably forgot to mention some other changes, but the idea is to create
+  official docs for KIAUH where the new changelog will live in the future and
+  available features and mechanics are explained in detail
+
+If you really want to use v5, there is a v5 branch available in the repository.
+Keep in mind that v5 will not be updated anymore.
+
 ### 2024-08-31 (v6.0.0-alpha.1)
+
 Long time no see, but here we are again!
-A lot has happened in the background, but now it is time to take it out into the wild.
+A lot has happened in the background, but now it is time to take it out into the
+wild.
 
 #### KIAUH has now reached version 6! Well, at least in an alpha state...
 
 The project has seen a complete rewrite of the script from scratch in Python.
-It requires Python 3.8 or newer to run. Because this update is still in an alpha state, bugs may or will occur.
-During startup, you will be asked if you want to start the new version 6 or the old version 5.
-As long as version 6 is in a pre-release state, version 5 will still be available. If there are any critical issues
-with the new version that were overlooked, you can always switch back to the old version.
+It requires Python 3.8 or newer to run. Because this update is still in an alpha
+state, bugs may or will occur.
+During startup, you will be asked if you want to start the new version 6 or the
+old version 5.
+As long as version 6 is in a pre-release state, version 5 will still be
+available. If there are any critical issues
+with the new version that were overlooked, you can always switch back to the old
+version.
 
-In case you selected not to get asked about which version to start (option 3 or 4 in the startup dialog) and you want to
-revert that decision, you will find a line called `version_to_launch=` within the `.kiauh.ini` file in your home directory.
-Just delete that line, save the file and restart KIAUH. KIAUH will then ask you again which version you want to start.
+In case you selected not to get asked about which version to start (option 3 or
+4 in the startup dialog) and you want to
+revert that decision, you will find a line called `version_to_launch=` within
+the `.kiauh.ini` file in your home directory.
+Just delete that line, save the file and restart KIAUH. KIAUH will then ask you
+again which version you want to start.
 
 Here is a list of the most important changes to KIAUH in regard to version 6:
-- The majority of features available in KIAUH v5 are still available; they just got migrated from Bash to Python.
-- It is now possible to add new/remove instances to/from existing multi-instance installations of Klipper and Moonraker
-- KIAUH now has an Extension-System. This allows contributors to add new installers to KIAUH without having to modify the main script.
-    - You will now find some of the features that were previously available in the Installer-Menu in the Extensions-Menu.
+
+- The majority of features available in KIAUH v5 are still available; they just
+  got migrated from Bash to Python.
+- It is now possible to add new/remove instances to/from existing multi-instance
+  installations of Klipper and Moonraker
+- KIAUH now has an Extension-System. This allows contributors to add new
+  installers to KIAUH without having to modify the main script.
+    - You will now find some of the features that were previously available in
+      the Installer-Menu in the Extensions-Menu.
     - The current extensions are:
         - G-Code Shell Command (previously found in the Advanced-Menu)
         - Mainsail Theme Installer (previously found in the Advanced-Menu)
@@ -37,192 +74,347 @@ Here is a list of the most important changes to KIAUH in regard to version 6:
     - The file has some default values for the currently supported options
     - There might be more options in the future
     - It is located in KIAUH's root directory and is called `default.kiauh.cfg`
-        - DO NOT EDIT the default file directly, instead make a copy of it and call it `kiauh.cfg`
-        - Settings changed via the Advanced-Menu will be written to the `kiauh.cfg`
+        - DO NOT EDIT the default file directly, instead make a copy of it and
+          call it `kiauh.cfg`
+        - Settings changed via the Advanced-Menu will be written to the
+          `kiauh.cfg`
 - Support for OctoPrint was removed
 
-Feel free to give version 6 a try and report any bugs or issues you encounter! Every feedback is appreciated.
+Feel free to give version 6 a try and report any bugs or issues you encounter!
+Every feedback is appreciated.
 
 ### 2023-06-17
+
 KIAUH has now added support for installing Mobileraker's companion!
-Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing the Moonraker API, allowing you
-to control your printer. Thank you to [Clon1998](https://github.com/Clon1998) for adding this feature!
+Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing
+the Moonraker API, allowing you
+to control your printer. Thank you to [Clon1998](https://github.com/Clon1998)
+for adding this feature!
 
 ### 2023-02-03
-The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer.
-Please have a look here for additional info about crowsnest and how to configure it: https://github.com/mainsail-crew/crowsnest \
-It's unsure if the previous MJPG-Streamer installer will be updated and make its way back into KIAUH.
-A big thanks to [KwadFan](https://github.com/KwadFan) for writing the crowsnest implementation.
+
+The installer for MJPG-Streamer got replaced by crowsnest. It is an improved
+webcam service, utilizing ustreamer.
+Please have a look here for additional info about crowsnest and how to configure
+it: https://github.com/mainsail-crew/crowsnest \
+It's unsure if the previous MJPG-Streamer installer will be updated and make its
+way back into KIAUH.
+A big thanks to [KwadFan](https://github.com/KwadFan) for writing the crowsnest
+implementation.
 
 ### 2022-10-31
+
 Some functions got updated, though not all of them.
 
 The following functions are still currently unavailable:
+
 - Installation of: MJPG-Streamer
 - All backup functions and the Log-Upload
 
 ### 2022-10-20
+
 KIAUH has now reached major version 5 !
 
-Recently Moonraker introduced some changes which makes it necessary to change the folder structure of printer setups.
-If you are interested in the details, check out this PR: https://github.com/Arksine/moonraker/pull/491 \
-Although Moonraker has some mechanics available to migrate existing setups to the new file structure with the use of symlinks, fresh and clean installs
+Recently Moonraker introduced some changes which makes it necessary to change
+the folder structure of printer setups.
+If you are interested in the details, check out this
+PR: https://github.com/Arksine/moonraker/pull/491 \
+Although Moonraker has some mechanics available to migrate existing setups to
+the new file structure with the use of symlinks, fresh and clean installs
 should be considered.
 
-The version jump of KIAUH to v5 is a breaking change due to those major changes! That means v4 and v5 are not compatible with each other!
-This is also the reason why you will currently be greeted by a yellow notification in the main menu of KIAUH leading to this changelog.
-I decided to disable a few functions of the script and focus on releasing the required changes to the core components of this script.
-I will work on updating the other parts of the script piece by piece during the next days/weeks.
-So I am already sorry in advance if one of your desired components you wanted to install or use temporarily cannot be installed or used right now.
+The version jump of KIAUH to v5 is a breaking change due to those major changes!
+That means v4 and v5 are not compatible with each other!
+This is also the reason why you will currently be greeted by a yellow
+notification in the main menu of KIAUH leading to this changelog.
+I decided to disable a few functions of the script and focus on releasing the
+required changes to the core components of this script.
+I will work on updating the other parts of the script piece by piece during the
+next days/weeks.
+So I am already sorry in advance if one of your desired components you wanted to
+install or use temporarily cannot be installed or used right now.
 
 The following functions are currently unavailable:
-- Installation of: KlipperScreen, Obico, Octoprint, MJPG-Streamer, Telegram Bot and PrettyGCode
+
+- Installation of: KlipperScreen, Obico, Octoprint, MJPG-Streamer, Telegram Bot
+  and PrettyGCode
 - All backup functions and the Log-Upload
 
 **So what is working?**\
-Installation of Klipper, Moonraker, Mainsail and Fluidd. Both, single and multi-instance setups work!\
-As already said, the rest will follow in the near future. Updating and removal of already installed components should continue to work.
+Installation of Klipper, Moonraker, Mainsail and Fluidd. Both, single and
+multi-instance setups work!\
+As already said, the rest will follow in the near future. Updating and removal
+of already installed components should continue to work.
 
 **What was removed?**\
-The option to change Klippers configuration directory got removed. From now on it will not be possible anymore to change
-the configuration directory from within KIAUH and the new filestructure is enforced.
+The option to change Klippers configuration directory got removed. From now on
+it will not be possible anymore to change
+the configuration directory from within KIAUH and the new filestructure is
+enforced.
 
 **What if I don't have an existing Klipper/Moonraker install right now?**\
-Nothing important to think about, install Klipper and Moonraker. KIAUH will install both of them with the new filestructure.
+Nothing important to think about, install Klipper and Moonraker. KIAUH will
+install both of them with the new filestructure.
 
 **What if I have an existing Klipper/Moonraker install?**\
-First of all: Backups! Please copy all of your config files and the Moonraker database (it is a hidden folder, usually `~/.moonraker_database`) to a safe location.
-After that, uninstall Klipper and Moonraker with KIAUH. You can then proceed and re-install both of them with KIAUH again. It is important that you are on KIAUH v5 for that!
-Once everything is installed again, you need to manually copy your configuration files from the old `~/klipper_config` folder to the new `~/printer_data/config` folder.
-Previous, by Moonraker created symlinks to folder of the old filestructure will not work anymore, you need to move the files to their new location now!
-Do the same with the two files inside of `~/.moonraker_database`. Move/copy them into `~/printer_data/database`. If `~/printer_data/database` is already populated with a `data.mdb` and `lock.mdb`
-delete them or simply overwrite them. Nothing should be lost as those should be empty database files. Anyway, you made backups, right?
-You can now proceed and restart Moonraker. Either from within Mainsail or Fluidd, or use SSH and execute `sudo systemctl restart moonraker`.
-If everything went smooth, you should be good to go again. If you see some Moonraker warnings about deprecated options in the `moonraker.conf`, go ahead and resolve them.
-I will not cover them in detail here. A good source is the Moonraker documentation: https://moonraker.readthedocs.io/en/latest/configuration/
+First of all: Backups! Please copy all of your config files and the Moonraker
+database (it is a hidden folder, usually `~/.moonraker_database`) to a safe
+location.
+After that, uninstall Klipper and Moonraker with KIAUH. You can then proceed and
+re-install both of them with KIAUH again. It is important that you are on KIAUH
+v5 for that!
+Once everything is installed again, you need to manually copy your configuration
+files from the old `~/klipper_config` folder to the new `~/printer_data/config`
+folder.
+Previous, by Moonraker created symlinks to folder of the old filestructure will
+not work anymore, you need to move the files to their new location now!
+Do the same with the two files inside of `~/.moonraker_database`. Move/copy them
+into `~/printer_data/database`. If `~/printer_data/database` is already
+populated with a `data.mdb` and `lock.mdb`
+delete them or simply overwrite them. Nothing should be lost as those should be
+empty database files. Anyway, you made backups, right?
+You can now proceed and restart Moonraker. Either from within Mainsail or
+Fluidd, or use SSH and execute `sudo systemctl restart moonraker`.
+If everything went smooth, you should be good to go again. If you see some
+Moonraker warnings about deprecated options in the `moonraker.conf`, go ahead
+and resolve them.
+I will not cover them in detail here. A good source is the Moonraker
+documentation: https://moonraker.readthedocs.io/en/latest/configuration/
 
 **What if I have an existing Klipper/Moonraker multi-instance install?**\
-Pretty much the same steps that are required for single instance installs apply to multi-instance setups. So please go ahead and read the previous paragraph if you didn't already.
-Make backups of everything first. Then remove and install the desired amount of Klipper and Moonraker instances again.
+Pretty much the same steps that are required for single instance installs apply
+to multi-instance setups. So please go ahead and read the previous paragraph if
+you didn't already.
+Make backups of everything first. Then remove and install the desired amount of
+Klipper and Moonraker instances again.
 Now you need to move all config and database files to their new locations.\
 Example with an instance called `printer_1`:\
-The config files go from `~/klipper_config/printer_1` to `~/printer_1_data/config`.
-The database files go from `~/.moonraker_database_1` to `~/printer_1_data/database`.
-Now restart all Moonraker services. You can restart all of them at once if you launch KIAUH, and in the main menu type `restart moonraker` and hit Enter.
+The config files go from `~/klipper_config/printer_1` to
+`~/printer_1_data/config`.
+The database files go from `~/.moonraker_database_1` to
+`~/printer_1_data/database`.
+Now restart all Moonraker services. You can restart all of them at once if you
+launch KIAUH, and in the main menu type `restart moonraker` and hit Enter.
 
-I hope I have covered the most important things. In case you need further support, the official Klipper Discord is a good place to ask for help.
+I hope I have covered the most important things. In case you need further
+support, the official Klipper Discord is a good place to ask for help.
 
 ### 2022-08-15
-Support for "Obico for Klipper" was added! Huge thanks to [kennethjiang](https://github.com/kennethjiang) for helping me with the implementation!
+
+Support for "Obico for Klipper" was added! Huge thanks
+to [kennethjiang](https://github.com/kennethjiang) for helping me with the
+implementation!
 
 ### 2022-05-29
+
 KIAUH has now reached major version 4 !
-* feat: Klipper can be installed under Python3 (still considered as experimental)
+
+* feat: Klipper can be installed under Python3 (still considered as
+  experimental)
 * feat: Klipper can be installed from custom repositories / inofficial forks
 * feat: Custom instance name for multi instance installations of Klipper
-  * Any other multi instance will share the same name given to the corresponding Klipper instance
+    * Any other multi instance will share the same name given to the
+      corresponding Klipper instance
     * E.g. klipper-voron2 -> moonraker-voron2 -> moonraker-telegram-bot-voron2
-* feat: Option to allow installation of / updating to unstable Mainsail and Fluidd versions
+* feat: Option to allow installation of / updating to unstable Mainsail and
+  Fluidd versions
     * by default only stable versions get installed/updated
-* feat: Multi-Instance OctoPrint installations now each have their own virtual python environment
+* feat: Multi-Instance OctoPrint installations now each have their own virtual
+  python environment
     * allows independent installation of plugins for each instance
 * feat: Implementing the use of shellcheck during development
 * feat: Implementing a simple logging mechanic
-* feat: Log-upload function now also allows uploading other logfiles (kiauh.log, webcamd.log etc.)
+* feat: Log-upload function now also allows uploading other logfiles (kiauh.log,
+  webcamd.log etc.)
 * feat: added several new help dialogs which try to explain various functions
-* fix: During Klipper installation, checks for group membership of `tty` and `dialout` are made
-* refactor: rework of the settings menu for better control the new KIAUH features
+* fix: During Klipper installation, checks for group membership of `tty` and
+  `dialout` are made
+* refactor: rework of the settings menu for better control the new KIAUH
+  features
 * refactor: Support for DWC and DWC-for-Klipper has been removed
-* refactor: The backup before update settings were moved to the KIAUH settings menu
-* refactor: Switch branch function has been removed (was replaced by the custom Klipper repo feature)
-* refactor: The update manager sections for Mainsail, Fluidd and KlipperScreen were removed from the moonraker.conf template
-  * They will now be individually added during installation of the corresponding interface
-* refactor: The rollback function was reworked and now also allows rollbacks of Moonraker
-  * It now takes numerical inputs and reverts the corresponding repository by the given amount instead
-  * KIAUH does not save previous states to its config anymore like it did with the previous approach
-
+* refactor: The backup before update settings were moved to the KIAUH settings
+  menu
+* refactor: Switch branch function has been removed (was replaced by the custom
+  Klipper repo feature)
+* refactor: The update manager sections for Mainsail, Fluidd and KlipperScreen
+  were removed from the moonraker.conf template
+    * They will now be individually added during installation of the
+      corresponding interface
+* refactor: The rollback function was reworked and now also allows rollbacks of
+  Moonraker
+    * It now takes numerical inputs and reverts the corresponding repository by
+      the given amount instead
+    * KIAUH does not save previous states to its config anymore like it did with
+      the previous approach
 
 ### 2022-01-29
-* Starting from the 28th of January, Moonraker can make use of PackageKit and PolicyKit.\
+
+* Starting from the 28th of January, Moonraker can make use of PackageKit and
+  PolicyKit.\
   More details on that can be found [here](
-https://github.com/Arksine/moonraker/issues/349) and [here](https://github.com/Arksine/moonraker/pull/346)
-* KIAUH will install Moonrakers PolicyKit rules by default when __installing__ Moonraker
-* KIAUH will also install Moonrakers PolicyKit rules when __updating__ Moonraker __via KIAUH__ as of now
+  https://github.com/Arksine/moonraker/issues/349)
+  and [here](https://github.com/Arksine/moonraker/pull/346)
+* KIAUH will install Moonrakers PolicyKit rules by default when __installing__
+  Moonraker
+* KIAUH will also install Moonrakers PolicyKit rules when __updating__ Moonraker
+  __via KIAUH__ as of now
 
 ### 2021-12-30
-* Updated the doc for the usage of the [G-Code Shell Command Extension](docs/gcode_shell_command.md)
-* It became apparent, that some user groups are missing on some systems. A missing video group \
-membership for example caused issues when installing mjpg-streamer while not using the default pi user. \
-Other issues could occur when trying to flash an MCU on Debian or Ubuntu distributions where a user might not be part
-of the dialout group by default. A check for the tty group is also done. The tty group is needed for setting
+
+* Updated the doc for the usage of
+  the [G-Code Shell Command Extension](docs/gcode_shell_command.md)
+* It became apparent, that some user groups are missing on some systems. A
+  missing video group \
+  membership for example caused issues when installing mjpg-streamer while not
+  using the default pi user. \
+  Other issues could occur when trying to flash an MCU on Debian or Ubuntu
+  distributions where a user might not be part
+  of the dialout group by default. A check for the tty group is also done. The
+  tty group is needed for setting
   up a linux MCU (currently not yet supported by KIAUH).
-* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework
- in comparison to 20.04 and users will be greeted with an "Error 403 - Permission denied" message after installing one of Klippers webinterfaces.
+* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10.
+  Permissions on that distro seem to have seen a rework
+  in comparison to 20.04 and users will be greeted with an "Error 403 -
+  Permission denied" message after installing one of Klippers webinterfaces.
   I still have to figure out a viable solution for that.
 
 ### 2021-09-28
-* New Feature! Added an installer for the Telegram Bot for Moonraker by [nlef](https://github.com/nlef).
-Checkout his project! Remember to report all issues and/or bugs regarding that project in its corresponding repo and not here 😛.\
+
+* New Feature! Added an installer for the Telegram Bot for Moonraker
+  by [nlef](https://github.com/nlef).
+  Checkout his project! Remember to report all issues and/or bugs regarding that
+  project in its corresponding repo and not here 😛.\
   You can find it here: https://github.com/nlef/moonraker-telegram-bot
 
 ### 2021-09-24
-* The flashing function got adjusted a bit. It is now possible to also flash controllers which are connected over UART and thus accessible via `/dev/ttyAMA0`. You now have to select a connection methop prior flashing which is either USB or UART.
-* Due to several requests over time I have now created a Ko-fi account for those who want to support this project and my work with a small donation. Many thanks in advance to all future donors. You can support me on Ko-fi with this link: https://ko-fi.com/th33xitus
-* As usual, if you find any bugs or issues please report them. I tested the little rework i did with the hardware i have available and haven't encountered any malfunctions of flashing them yet.
+
+* The flashing function got adjusted a bit. It is now possible to also flash
+  controllers which are connected over UART and thus accessible via
+  `/dev/ttyAMA0`. You now have to select a connection methop prior flashing
+  which is either USB or UART.
+* Due to several requests over time I have now created a Ko-fi account for those
+  who want to support this project and my work with a small donation. Many
+  thanks in advance to all future donors. You can support me on Ko-fi with this
+  link: https://ko-fi.com/th33xitus
+* As usual, if you find any bugs or issues please report them. I tested the
+  little rework i did with the hardware i have available and haven't encountered
+  any malfunctions of flashing them yet.
 
 ### 2021-08-10
-* KIAUH now supports the installation of the "PrettyGCode for Klipper" GCode-Viewer created by [Kragrathea](https://github.com/Kragrathea)! Installation, updating and removal are possible with KIAUH. For more details to this cool piece of software, please have a look here: https://github.com/Kragrathea/pgcode
+
+* KIAUH now supports the installation of the "PrettyGCode for Klipper"
+  GCode-Viewer created by [Kragrathea](https://github.com/Kragrathea)!
+  Installation, updating and removal are possible with KIAUH. For more details
+  to this cool piece of software, please have a look
+  here: https://github.com/Kragrathea/pgcode
 
 ### 2021-07-10
-* The NGINX configuration files got updated to be in sync with MainsailOS and FluiddPi. Issues with the NGINX service not starting up due to wrong configuration should be resolved now. To get the updated configuration files, please remove Moonraker and Mainsail / Fluidd with KIAUH first and then re-install it. An automated file check for those configuration files might follow in the future which then automates updating those files if there were important changes.
 
-* The default `moonraker.conf` was updated to reflect the recent changes to the update manager section. The update channel is set to `dev`.
+* The NGINX configuration files got updated to be in sync with MainsailOS and
+  FluiddPi. Issues with the NGINX service not starting up due to wrong
+  configuration should be resolved now. To get the updated configuration files,
+  please remove Moonraker and Mainsail / Fluidd with KIAUH first and then
+  re-install it. An automated file check for those configuration files might
+  follow in the future which then automates updating those files if there were
+  important changes.
+
+* The default `moonraker.conf` was updated to reflect the recent changes to the
+  update manager section. The update channel is set to `dev`.
 
 ### 2021-06-29
-* KIAUH will now patch the new `log_path` to existing moonraker.conf files when updating Moonraker and the entry is missing. Before that, it was necessary that the user provided that path manually to make Fluidd display the logfiles in its interface. This issue should be resolved now.
+
+* KIAUH will now patch the new `log_path` to existing moonraker.conf files when
+  updating Moonraker and the entry is missing. Before that, it was necessary
+  that the user provided that path manually to make Fluidd display the logfiles
+  in its interface. This issue should be resolved now.
 
 ### 2021-06-15
 
-* Moonraker introduced an optional `log_path` which clients can make use of to show log files located in that folder to their users. More info here: https://github.com/Arksine/moonraker/commit/829b3a4ee80579af35dd64a37ccc092a1f67682a \
-Client developers agreed upon using `~/klipper_logs` as the new default log path.\
-That means, from now on, Klipper and Moonraker services installed with KIAUH will place their logfiles in that mentioned folder.
-* Additionally, KIAUH will now detect Klipper and Moonraker systemd services that still use the old default location of `/tmp/<service>.log` and will update them next time the user updates Klipper and/or Moonraker with the KIAUH update function.
-* Additional symlinks for the following logfiles will get created along those update procedures to make them accessible through the webinterface once its supported:
+* Moonraker introduced an optional `log_path` which clients can make use of to
+  show log files located in that folder to their users. More info
+  here: https://github.com/Arksine/moonraker/commit/829b3a4ee80579af35dd64a37ccc092a1f67682a \
+  Client developers agreed upon using `~/klipper_logs` as the new default log
+  path.\
+  That means, from now on, Klipper and Moonraker services installed with KIAUH
+  will place their logfiles in that mentioned folder.
+* Additionally, KIAUH will now detect Klipper and Moonraker systemd services
+  that still use the old default location of `/tmp/<service>.log` and will
+  update them next time the user updates Klipper and/or Moonraker with the KIAUH
+  update function.
+* Additional symlinks for the following logfiles will get created along those
+  update procedures to make them accessible through the webinterface once its
+  supported:
     - webcamd.log
     - mainsail-access.log
     - mainsail-error.log
     - fluidd-access.log
     - fluidd-error.log
 * For MainsailOS and FluiddPi users:\
-MainsailOS and FluiddPi will switch the shipped Klipper service from SysVinit to systemd probably with their next release. KIAUH can already help migrate older MainsailOS (0.4.0 and below) and FluiddPi (v1.13.0) releases to match their new service-, file- and folder-structure so you don't have to re-flash the SD-Card of your Raspberry Pi.\
-In detail here is what is going to happen when you use the new "CustomPiOS Migration Helper" from the Advanced Menu\
+  MainsailOS and FluiddPi will switch the shipped Klipper service from SysVinit
+  to systemd probably with their next release. KIAUH can already help migrate
+  older MainsailOS (0.4.0 and below) and FluiddPi (v1.13.0) releases to match
+  their new service-, file- and folder-structure so you don't have to re-flash
+  the SD-Card of your Raspberry Pi.\
+  In detail here is what is going to happen when you use the new "CustomPiOS
+  Migration Helper" from the Advanced Menu\
   `(Main Menu -> 4 -> Enter -> 10 -> Enter)` in a short summary:
-    * The Klipper SysVinit service will get replaced by a Klipper systemd service
+    * The Klipper SysVinit service will get replaced by a Klipper systemd
+      service
     * Klipper and Moonraker will use the new log-directory `~/klipper_logs`
     * The webcamd service gets updated
-    * The webcamd script gets updated and moved from `/root/bin/webcamd` to `/usr/local/bin/webcamd`
-    * The NGINX `upstreams.conf` gets updated to be able to configure up to 4 webcams
-    * The `mainsail.txt` / `fluiddpi.txt` gets moved from `/boot` to `~/klipper_config` and renamed to `webcam.txt`
-    * Symlinks for the webcamd.log and various NGINX logs get created in `~/klipper_config`
-    * Configuration files for Klipper, Moonraker and webcamd get added to `/etc/logrotate.d`
-    * If they still exist, two lines will be removed from the mainsail.cfg or client_macros.cfg macro configurations:\
-    `SAVE_GCODE_STATE NAME=PAUSE_state` and `RESTORE_GCODE_STATE NAME=PAUSE_state`
+    * The webcamd script gets updated and moved from `/root/bin/webcamd` to
+      `/usr/local/bin/webcamd`
+    * The NGINX `upstreams.conf` gets updated to be able to configure up to 4
+      webcams
+    * The `mainsail.txt` / `fluiddpi.txt` gets moved from `/boot` to
+      `~/klipper_config` and renamed to `webcam.txt`
+    * Symlinks for the webcamd.log and various NGINX logs get created in
+      `~/klipper_config`
+    * Configuration files for Klipper, Moonraker and webcamd get added to
+      `/etc/logrotate.d`
+    * If they still exist, two lines will be removed from the mainsail.cfg or
+      client_macros.cfg macro configurations:\
+      `SAVE_GCODE_STATE NAME=PAUSE_state` and
+      `RESTORE_GCODE_STATE NAME=PAUSE_state`
 * **Please note:**\
-The "CustomPiOS Migration Helper" is intended to only work on "vanilla" MainsailOS and FluiddPi systems. Do not try to migrate a modified MainsailOS or FluiddPi system (for example if you already used KIAUH to re-install services or to set up a multi-instance installation for Klipper / Moonraker). This won't work.
+  The "CustomPiOS Migration Helper" is intended to only work on "vanilla"
+  MainsailOS and FluiddPi systems. Do not try to migrate a modified MainsailOS
+  or FluiddPi system (for example if you already used KIAUH to re-install
+  services or to set up a multi-instance installation for Klipper / Moonraker).
+  This won't work.
 
 ### 2021-01-31
 
 * **This is a big one... KIAUH v3.0 is out.**\
-With this update you can now install multiple instances of Klipper, Moonraker, Duet Web Control or Octoprint on the same Pi. This was quite a big rework of the whole script. So bugs can appear but with the help of some testers, i think there shouldn't be any critical ones anymore. In this regards thanks to @lixxbox and @zellneralex for testing.
+  With this update you can now install multiple instances of Klipper, Moonraker,
+  Duet Web Control or Octoprint on the same Pi. This was quite a big rework of
+  the whole script. So bugs can appear but with the help of some testers, i
+  think there shouldn't be any critical ones anymore. In this regards thanks to
+  @lixxbox and @zellneralex for testing.
 
-* Important changes to how installations are set up now: All components get installed as systemd services. Installation via init.d was dropped completely! This shouldn't affect you at all, since the common linux distributions like RaspberryPi OS or custom distributions like MainsailOS, FluiddPi or OctoPi support both ways of installing services. I just wanted to mention it here.
+* Important changes to how installations are set up now: All components get
+  installed as systemd services. Installation via init.d was dropped completely!
+  This shouldn't affect you at all, since the common linux distributions like
+  RaspberryPi OS or custom distributions like MainsailOS, FluiddPi or OctoPi
+  support both ways of installing services. I just wanted to mention it here.
 
-* Now with KIAUH v3.0 and multi-instance installation capabilities, there are some things to point out. You will now need to tell KIAUH where your printers configurations are located when installing Klipper for the first time. Even though it is not recommended, you can change this location with the help of KIAUH and rewrite Klipper and Moonraker to use the new location.
+* Now with KIAUH v3.0 and multi-instance installation capabilities, there are
+  some things to point out. You will now need to tell KIAUH where your printers
+  configurations are located when installing Klipper for the first time. Even
+  though it is not recommended, you can change this location with the help of
+  KIAUH and rewrite Klipper and Moonraker to use the new location.
 
-* When setting up a multi-instance system, the folder structure will only change slightly. The goal was to keep it as compatible as possible with the custom distributions like mainsailOS and FluiddPi. This should help converting a single-instance setup of mainsailOS/FluiddPi to a multi-instance setup in no time, but keeping single-instance backwards compatibility if needed at a later point in time.
+* When setting up a multi-instance system, the folder structure will only change
+  slightly. The goal was to keep it as compatible as possible with the custom
+  distributions like mainsailOS and FluiddPi. This should help converting a
+  single-instance setup of mainsailOS/FluiddPi to a multi-instance setup in no
+  time, but keeping single-instance backwards compatibility if needed at a later
+  point in time.
 
 * The folder structure is as follows when setting up multi-instances:\
-Each printer instance will get its own folder within your configuration location. The decision to this specific structure was made to make it as painless and easy as possible to convert to a multi-instance setup.
+  Each printer instance will get its own folder within your configuration
+  location. The decision to this specific structure was made to make it as
+  painless and easy as possible to convert to a multi-instance setup.
   Here is an example:
     ```shell
     /home/<username>
@@ -237,10 +429,12 @@ Here is an example:
                       ├── printer.cfg
                       └── moonraker.conf
     ```
-* Also when setting up multi-instances of each service, the name of each service slightly changes.
+* Also when setting up multi-instances of each service, the name of each service
+  slightly changes.
   Each service gets its corresponding instance added to the service filename.
 
-    **This only applies to multi-instances! Single instance installations with KIAUH will keep their original names!**
+  **This only applies to multi-instances! Single instance installations with
+  KIAUH will keep their original names!**
 
   Corresponding to the filetree example from above that would mean:
     ```
@@ -254,52 +448,102 @@ Each service gets its corresponding instance added to the service filename.
             --> moonraker-2.service
             --> moonraker-n.service
     ```
-* The same service file rules from above apply to OctoPrint even though only Klipper and Moonraker are shown in this example.
+* The same service file rules from above apply to OctoPrint even though only
+  Klipper and Moonraker are shown in this example.
 
-* You can start, stop and restart all Klipper, Moonraker and OctoPrint instances from the KIAUH main menu. For doing this, just type "stop klipper", "start moonraker", "restart octoprint" and so on.
+* You can start, stop and restart all Klipper, Moonraker and OctoPrint instances
+  from the KIAUH main menu. For doing this, just type "stop klipper", "start
+  moonraker", "restart octoprint" and so on.
 
-* KIAUH v3.0 relocated its ini-file. It is now a hidden file in the users home-directory calles `.kiauh.ini`. This has the benefit of keeping all values in that file between possible re-installations of KIAUH. Otherwise that file would be lost.
+* KIAUH v3.0 relocated its ini-file. It is now a hidden file in the users
+  home-directory calles `.kiauh.ini`. This has the benefit of keeping all values
+  in that file between possible re-installations of KIAUH. Otherwise that file
+  would be lost.
 
-* The option of adding more trusted clients to the moonraker.conf file was dropped. Since you can edit this file right inside of Mainsail or Fluidd, only some basic entries are made which get you running.
+* The option of adding more trusted clients to the moonraker.conf file was
+  dropped. Since you can edit this file right inside of Mainsail or Fluidd, only
+  some basic entries are made which get you running.
 
-* I bet i have missed mentioning other stuff as well because it took me quite some time to re-write many functions. So i just hope you like the new version 😄
+* I bet i have missed mentioning other stuff as well because it took me quite
+  some time to re-write many functions. So i just hope you like the new version
+  😄
 
 ### 2020-11-28
 
-* KIAUH now supports the installation, update and removal of [KlipperScreen](https://github.com/jordanruthe/KlipperScreen). This feature was was provided by [jordanruthe](https://github.com/jordanruthe)! Thank you!
+* KIAUH now supports the installation, update and removal
+  of [KlipperScreen](https://github.com/jordanruthe/KlipperScreen). This feature
+  was was provided by [jordanruthe](https://github.com/jordanruthe)! Thank you!
 
 ### 2020-11-18
 
-* Some changes to Fluidd caused a little rework on how KIAUH will install/update Fluidd from now on. Please see the [fluidd v1.0.0-rc0 release notes](https://github.com/cadriel/fluidd/releases/tag/v1.0.0-rc.0) for further information about what modifications to the moonraker.conf file exactly had to be done. In a nutshell, KIAUH will now always patch the required entries to the moonraker.conf if not already there.
+* Some changes to Fluidd caused a little rework on how KIAUH will install/update
+  Fluidd from now on. Please see
+  the [fluidd v1.0.0-rc0 release notes](https://github.com/cadriel/fluidd/releases/tag/v1.0.0-rc.0)
+  for further information about what modifications to the moonraker.conf file
+  exactly had to be done. In a nutshell, KIAUH will now always patch the
+  required entries to the moonraker.conf if not already there.
 
 ### 2020-10-30:
 
 * The user can now choose to install Klipper as a systemd service.
 
-* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](gcode_shell_command.md) has been updated accordingly.
+* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell
+  Command extension and `gcode_shell_command.py`. In case
+  the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be
+  merged in the future, this was an early attempt to dodge possible
+  incompatibilities. The [G-Code Shell Command docs](gcode_shell_command.md) has
+  been updated accordingly.
 
-* The way how KIAUH interacts and writes to the users printer.cfg got changed. Usually KIAUH wrote everything directly into the printer.cfg. The way it will work from now on is, that a new file called `kiauh.cfg` will be created if there is something that needs to be written to the printer.cfg and everything gets written to `kiauh.cfg` instead. The only thing which then gets written to the users printer.cfg is `[include kiauh.cfg]`. This line will be located at the very top of the existing printer.cfg with a little comment as a note. The user can then decide to either keep the `kiauh.cfg` or take its content, places it into the printer.cfg directly and remove the `[include kiauh.cfg]`.
+* The way how KIAUH interacts and writes to the users printer.cfg got changed.
+  Usually KIAUH wrote everything directly into the printer.cfg. The way it will
+  work from now on is, that a new file called `kiauh.cfg` will be created if
+  there is something that needs to be written to the printer.cfg and everything
+  gets written to `kiauh.cfg` instead. The only thing which then gets written to
+  the users printer.cfg is `[include kiauh.cfg]`. This line will be located at
+  the very top of the existing printer.cfg with a little comment as a note. The
+  user can then decide to either keep the `kiauh.cfg` or take its content,
+  places it into the printer.cfg directly and remove the `[include kiauh.cfg]`.
 
-* The `mainsail_macros.cfg` got renamed to `webui_macros.cfg`. Since Mainsail and Fluidd both use the same kind of pause, cancel and resume macros, a more generic name was chosen for the file containing the example macros one can choose to install when installing those webinterfaces.
+* The `mainsail_macros.cfg` got renamed to `webui_macros.cfg`. Since Mainsail
+  and Fluidd both use the same kind of pause, cancel and resume macros, a more
+  generic name was chosen for the file containing the example macros one can
+  choose to install when installing those webinterfaces.
 
 ### 2020-10-10:
 
-* Support for changing the Klipper branch to the moonraker-dev branch from @Arksine has been dropped. Support for Moonraker has been merged into Klipper mainline a long time ago.
+* Support for changing the Klipper branch to the moonraker-dev branch from
+  @Arksine has been dropped. Support for Moonraker has been merged into Klipper
+  mainline a long time ago.
 
-* A new function is available from the main menu. You can now upload your log files to http://paste.c-net.org/ to share them for debugging purposes.
+* A new function is available from the main menu. You can now upload your log
+  files to http://paste.c-net.org/ to share them for debugging purposes.
 
 ### 2020-10-06:
 
-* Fluidd, a new Klipper interface got added to the list of available installers. At the same time some installation routines have changed or have seen some rework. Changes were made to the installation of NGINX configurations. A method was introduced to change the listen port of a webinterface configuration if there is already another webinterface listening on the default port (80).
+* Fluidd, a new Klipper interface got added to the list of available installers.
+  At the same time some installation routines have changed or have seen some
+  rework. Changes were made to the installation of NGINX configurations. A
+  method was introduced to change the listen port of a webinterface
+  configuration if there is already another webinterface listening on the
+  default port (80).
 
-* At the moment, the Moonraker installer no longer asks you whether you want to install a web interface too. For now you therefore have to install them with their respective installers. Please report any bugs or issues you encounter.
+* At the moment, the Moonraker installer no longer asks you whether you want to
+  install a web interface too. For now you therefore have to install them with
+  their respective installers. Please report any bugs or issues you encounter.
 
 ### 2020-09-17:
 
-* The dev-2.0 branch will be abandoned as of today. If you did a checkout to that branch in the past, you have to checkout back to master to receive updates.
+* The dev-2.0 branch will be abandoned as of today. If you did a checkout to
+  that branch in the past, you have to checkout back to master to receive
+  updates.
 
 ### 2020-09-12:
 
-* The old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) won't be supported anymore!\
-The is a new, fully rewritten project available: [dwc2-for-klipper-socket](https://github.com/Stephan3/dwc2-for-klipper-socket).\
-The installer of this script also got rewritten to make use of that new project. You will not be able to install or remove the old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) with KIAUH anymore if you updated KIAUH to the newest version.
+* The old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) won't
+  be supported anymore!\
+  The is a new, fully rewritten project
+  available: [dwc2-for-klipper-socket](https://github.com/Stephan3/dwc2-for-klipper-socket).\
+  The installer of this script also got rewritten to make use of that new
+  project. You will not be able to install or remove the
+  old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) with
+  KIAUH anymore if you updated KIAUH to the newest version.

kiauh.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -10,16 +10,11 @@
 #=======================================================================#
 
 set -e
-clear
+clear -x
 
 # make sure we have the correct permissions while running the script
 umask 022
 
-### sourcing all additional scripts
-KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
-for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
-for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
-
 #===================================================#
 #=================== UPDATE KIAUH ==================#
 #===================================================#
@@ -57,26 +52,17 @@ function kiauh_update_avail() {
   fi
 }
 
-function save_startup_version() {
-  local launch_version
-
-  echo "${1}"
-
-  sed -i "/^version_to_launch=/d" "${INI_FILE}"
-  sed -i '$a'"version_to_launch=${1}" "${INI_FILE}"
-}
-
 function kiauh_update_dialog() {
   [[ ! $(kiauh_update_avail) == "true" ]] && return
-  top_border
+  echo -e "/-------------------------------------------------------\\"
   echo -e "|${green}              New KIAUH update available!              ${white}|"
-  hr
+  echo -e "|-------------------------------------------------------|"
   echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
-  blank_line
+  echo -e "|                                                       |"
   echo -e "|${yellow}  It is recommended to keep KIAUH up to date. Updates  ${white}|"
   echo -e "|${yellow}  usually contain bugfixes, important changes or new   ${white}|"
   echo -e "|${yellow}  features. Please consider updating!                  ${white}|"
-  bottom_border
+  echo -e "\-------------------------------------------------------/"
 
   local yn
   read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
@@ -93,11 +79,35 @@ function kiauh_update_dialog() {
   done
 }
 
-function launch_kiauh_v5() {
-    main_menu
+function check_euid() {
+  if [[ ${EUID} -eq 0 ]]; then
+    echo -e "${red}"
+    echo -e "/-------------------------------------------------------\\"
+    echo -e "|       !!! THIS SCRIPT MUST NOT RUN AS ROOT !!!        |"
+    echo -e "|                                                       |"
+    echo -e "|        It will ask for credentials as needed.         |"
+    echo -e "\-------------------------------------------------------/"
+    echo -e "${white}"
+    exit 1
+  fi
 }
 
-function launch_kiauh_v6() {
+function check_if_ratos() {
+  if [[ -n $(which ratos) ]]; then
+    echo -e "${red}"
+    echo -e "/-------------------------------------------------------\\"
+    echo -e "|        !!! RatOS 2.1 or greater detected !!!          |"
+    echo -e "|                                                       |"
+    echo -e "|        KIAUH does currently not support RatOS.        |"
+    echo -e "| If you have any questions, please ask for help on the |"
+    echo -e "| RatRig Community Discord: https://discord.gg/ratrig   |"
+    echo -e "\-------------------------------------------------------/"
+    echo -e "${white}"
+    exit 1
+  fi
+}
+
+function main() {
    local entrypoint
 
    if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
@@ -110,68 +120,11 @@ function launch_kiauh_v6() {
 
    export PYTHONPATH="${entrypoint}"
 
-  clear
-  python3 "${entrypoint}/kiauh.py"
-}
-
-function main() {
-  read_kiauh_ini "${FUNCNAME[0]}"
-
-  if [[ ${version_to_launch} -eq 5 ]]; then
-    launch_kiauh_v5
-  elif [[ ${version_to_launch} -eq 6 ]]; then
-    launch_kiauh_v6
-  else
-    top_border
-    echo -e "|         ${green}KIAUH v6.0.0-alpha1 is available now!${white}         |"
-    hr
-    echo -e "|         View Changelog: ${magenta}https://git.io/JnmlX${white}          |"
-    blank_line
-    echo -e "| KIAUH v6 was completely rewritten from the ground up. |"
-    echo -e "| It's based on Python 3.8 and has many improvements.   |"
-    blank_line
-    echo -e "| ${yellow}NOTE: Version 6 is still in alpha, so bugs may occur!${white} |"
-    echo -e "| ${yellow}Yet, your feedback and bug reports are very much${white}      |"
-    echo -e "| ${yellow}appreciated and will help finalize the release.${white}       |"
-    hr
-    echo -e "| Would you like to try out KIAUH v6?                   |"
-    echo -e "| 1) Yes                                                |"
-    echo -e "| 2) No                                                 |"
-    echo -e "| 3) Yes, remember my choice for next time              |"
-    echo -e "| 4) No, remember my choice for next time               |"
-    quit_footer
-    while true; do
-      read -p "${cyan}###### Select action:${white} " -e input
-      case "${input}" in
-        1)
-          launch_kiauh_v6
-          break;;
-        2)
-          launch_kiauh_v5
-          break;;
-        3)
-          save_startup_version 6
-          launch_kiauh_v6
-          break;;
-        4)
-          save_startup_version 5
-          launch_kiauh_v5
-          break;;
-        Q|q)
-          echo -e "${green}###### Happy printing! ######${white}"; echo
-          exit 0;;
-        *)
-          error_msg "Invalid Input!\n";;
-      esac
-    done && input=""
-  fi
+   clear -x
+   python3 "${entrypoint}/kiauh/main.py"
 }
 
 check_if_ratos
 check_euid
-init_logfile
-set_globals
 kiauh_update_dialog
-read_kiauh_ini
-init_ini
 main

kiauh/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/crowsnest/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -9,7 +9,6 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -20,7 +19,6 @@ CROWSNEST_SERVICE_NAME = "crowsnest.service"
 
 # directories
 CROWSNEST_DIR = Path.home().joinpath("crowsnest")
-CROWSNEST_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("crowsnest-backups")
 
 # files
 CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")

kiauh/components/crowsnest/crowsnest.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -15,7 +15,6 @@ from subprocess import CalledProcessError, run
 from typing import List
 
 from components.crowsnest import (
-    CROWSNEST_BACKUP_DIR,
     CROWSNEST_BIN_FILE,
     CROWSNEST_DIR,
     CROWSNEST_INSTALL_SCRIPT,
@@ -26,11 +25,10 @@ from components.crowsnest import (
     CROWSNEST_SERVICE_NAME,
 )
 from components.klipper.klipper import Klipper
-from core.backup_manager.backup_manager import BackupManager
-from core.constants import CURRENT_USER
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
-from core.types import ComponentStatus
+from core.types.component_status import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
@@ -73,7 +71,7 @@ def install_crowsnest() -> None:
     Logger.print_info("Installer will prompt you for sudo password!")
     try:
         run(
-            f"sudo make install BASE_USER={CURRENT_USER}",
+            "sudo make install",
             cwd=CROWSNEST_DIR,
             shell=True,
             check=True,
@@ -128,14 +126,14 @@ def update_crowsnest() -> None:
 
             settings = KiauhSettings()
             if settings.kiauh.backup_before_update:
-                bm = BackupManager()
-                bm.backup_directory(
-                    CROWSNEST_DIR.name,
-                    source=CROWSNEST_DIR,
-                    target=CROWSNEST_BACKUP_DIR,
+                svc = BackupService()
+                svc.backup_directory(
+                    source_path=CROWSNEST_DIR,
+                    target_path="crowsnest",
+                    backup_name="crowsnest",
                 )
 
-            git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
+            git_pull_wrapper(CROWSNEST_DIR)
 
             deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
             check_install_dependencies({*deps})

kiauh/components/klipper/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -9,10 +9,10 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 MODULE_PATH = Path(__file__).resolve().parent
 
+KLIPPER_REPO_URL = "https://github.com/Klipper3d/klipper.git"
+
 # names
 KLIPPER_LOG_NAME = "klippy.log"
 KLIPPER_CFG_NAME = "printer.cfg"
@@ -23,8 +23,8 @@ KLIPPER_SERVICE_NAME = "klipper.service"
 
 # directories
 KLIPPER_DIR = Path.home().joinpath("klipper")
+KLIPPER_KCONFIGS_DIR = Path.home().joinpath("klipper-kconfigs")
 KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
-KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
 
 # files
 KLIPPER_REQ_FILE = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")

kiauh/components/klipper/klipper.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/klipper/klipper_dialogs.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -11,13 +11,8 @@ import textwrap
 from enum import Enum, unique
 from typing import List
 
-from core.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
 from core.menus.base_menu import print_back_footer
+from core.types.color import Color
 from utils.instance_type import InstanceType
 
 
@@ -42,12 +37,12 @@ def print_instance_overview(
             if display_type is DisplayType.SERVICE_NAME
             else "printer directories"
         )
-        headline = f"{COLOR_GREEN}The following {d_type} were found:{RESET_FORMAT}"
+        headline = Color.apply(f"The following {d_type} were found:", Color.GREEN)
         dialog += f"║{headline:^64}║\n"
         dialog += "╟───────────────────────────────────────────────────────╢\n"
 
     if show_select_all:
-        select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+        select_all = Color.apply("a) Select all", Color.YELLOW)
         dialog += f"║ {select_all:<63}║\n"
         dialog += "║                                                       ║\n"
 
@@ -56,7 +51,9 @@ def print_instance_overview(
             name = s.service_file_path.stem
         else:
             name = s.data_dir
-        line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"
+        line = Color.apply(
+            f"{f'{i + start_index})' if show_index else '●'} {name}", Color.CYAN
+        )
         dialog += f"║ {line:<63}║\n"
     dialog += "╟───────────────────────────────────────────────────────╢\n"
 
@@ -65,8 +62,10 @@ def print_instance_overview(
 
 
 def print_select_instance_count_dialog() -> None:
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
-    line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
+    line1 = Color.apply("WARNING:", Color.YELLOW)
+    line2 = Color.apply(
+        "Setting up too many instances may crash your system.", Color.YELLOW
+    )
     dialog = textwrap.dedent(
         f"""
         ╔═══════════════════════════════════════════════════════╗
@@ -85,8 +84,8 @@ def print_select_instance_count_dialog() -> None:
 
 
 def print_select_custom_name_dialog() -> None:
-    line1 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
-    line2 = f"{COLOR_YELLOW}Only alphanumeric characters are allowed!{RESET_FORMAT}"
+    line1 = Color.apply("INFO:", Color.YELLOW)
+    line2 = Color.apply("Only alphanumeric characters are allowed!", Color.YELLOW)
     dialog = textwrap.dedent(
         f"""
         ╔═══════════════════════════════════════════════════════╗

kiauh/components/klipper/klipper_remove.py

@@ -1,95 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-from typing import List
-
-from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import print_instance_overview
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from utils.fs_utils import run_remove_routines
-from utils.input_utils import get_selection_input
-from utils.instance_utils import get_instances
-from utils.sys_utils import unit_file_exists
-
-
-def run_klipper_removal(
-    remove_service: bool,
-    remove_dir: bool,
-    remove_env: bool,
-) -> None:
-    klipper_instances: List[Klipper] = get_instances(Klipper)
-
-    if remove_service:
-        Logger.print_status("Removing Klipper instances ...")
-        if klipper_instances:
-            instances_to_remove = select_instances_to_remove(klipper_instances)
-            remove_instances(instances_to_remove)
-        else:
-            Logger.print_info("No Klipper Services installed! Skipped ...")
-
-    if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
-        Logger.print_info("There are still other Klipper services installed:")
-        Logger.print_info(f"● '{KLIPPER_DIR}' was not removed.", prefix=False)
-        Logger.print_info(f"● '{KLIPPER_ENV_DIR}' was not removed.", prefix=False)
-    else:
-        if remove_dir:
-            Logger.print_status("Removing Klipper local repository ...")
-            run_remove_routines(KLIPPER_DIR)
-        if remove_env:
-            Logger.print_status("Removing Klipper Python environment ...")
-            run_remove_routines(KLIPPER_ENV_DIR)
-
-
-def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
-    start_index = 1
-    options = [str(i + start_index) for i in range(len(instances))]
-    options.extend(["a", "b"])
-    instance_map = {options[i]: instances[i] for i in range(len(instances))}
-
-    print_instance_overview(
-        instances,
-        start_index=start_index,
-        show_index=True,
-        show_select_all=True,
-    )
-    selection = get_selection_input("Select Klipper instance to remove", options)
-
-    instances_to_remove = []
-    if selection == "b":
-        return None
-    elif selection == "a":
-        instances_to_remove.extend(instances)
-    else:
-        instances_to_remove.append(instance_map[selection])
-
-    return instances_to_remove
-
-
-def remove_instances(
-    instance_list: List[Klipper] | None,
-) -> None:
-    if not instance_list:
-        return
-
-    for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
-        InstanceManager.remove(instance)
-        delete_klipper_env_file(instance)
-
-
-def delete_klipper_env_file(instance: Klipper):
-    Logger.print_status(f"Remove '{instance.env_file}'")
-    if not instance.env_file.exists():
-        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
-        Logger.print_info(msg)
-        return
-    run_remove_routines(instance.env_file)

kiauh/components/klipper/klipper_setup.py

@@ -1,239 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-from pathlib import Path
-from typing import Dict, List, Tuple
-
-from components.klipper import (
-    EXIT_KLIPPER_SETUP,
-    KLIPPER_DIR,
-    KLIPPER_ENV_DIR,
-    KLIPPER_INSTALL_SCRIPT,
-    KLIPPER_REQ_FILE,
-)
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import (
-    print_select_custom_name_dialog,
-)
-from components.klipper.klipper_utils import (
-    assign_custom_name,
-    backup_klipper_dir,
-    check_user_groups,
-    create_example_printer_cfg,
-    get_install_count,
-    handle_disruptive_system_packages,
-)
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.client_utils import (
-    get_existing_clients,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import DialogType, Logger
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    create_python_venv,
-    install_python_requirements,
-    parse_packages_from_file,
-)
-
-
-def install_klipper() -> None:
-    Logger.print_status("Installing Klipper ...")
-
-    klipper_list: List[Klipper] = get_instances(Klipper)
-    moonraker_list: List[Moonraker] = get_instances(Moonraker)
-    match_moonraker: bool = False
-
-    # if there are more moonraker instances than klipper instances, ask the user to
-    # match the klipper instance count to the count of moonraker instances with the same suffix
-    if len(moonraker_list) > len(klipper_list):
-        is_confirmed = display_moonraker_info(moonraker_list)
-        if not is_confirmed:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return
-        match_moonraker = True
-
-    install_count, name_dict = get_install_count_and_name_dict(
-        klipper_list, moonraker_list
-    )
-
-    if install_count == 0:
-        Logger.print_status(EXIT_KLIPPER_SETUP)
-        return
-
-    is_multi_install = install_count > 1 or (len(name_dict) >= 1 and install_count >= 1)
-    if not name_dict and install_count == 1:
-        name_dict = {0: ""}
-    elif is_multi_install and not match_moonraker:
-        custom_names = use_custom_names_or_go_back()
-        if custom_names is None:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return
-
-        handle_instance_names(install_count, name_dict, custom_names)
-
-    create_example_cfg = get_confirm("Create example printer.cfg?")
-    # run the actual installation
-    try:
-        run_klipper_setup(klipper_list, name_dict, create_example_cfg)
-    except Exception as e:
-        Logger.print_error(e)
-        Logger.print_error("Klipper installation failed!")
-        return
-
-
-def run_klipper_setup(
-    klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
-) -> None:
-    if not klipper_list:
-        setup_klipper_prerequesites()
-
-    for i in name_dict:
-        # skip this iteration if there is already an instance with the name
-        if name_dict[i] in [n.suffix for n in klipper_list]:
-            continue
-
-        instance = Klipper(suffix=name_dict[i])
-        instance.create()
-        cmd_sysctl_service(instance.service_file_path.name, "enable")
-
-        if create_example_cfg:
-            # if a client-config is installed, include it in the new example cfg
-            clients = get_existing_clients()
-            create_example_printer_cfg(instance, clients)
-
-        cmd_sysctl_service(instance.service_file_path.name, "start")
-
-    cmd_sysctl_manage("daemon-reload")
-
-    # step 4: check/handle conflicting packages/services
-    handle_disruptive_system_packages()
-
-    # step 5: check for required group membership
-    check_user_groups()
-
-
-def handle_instance_names(
-    install_count: int, name_dict: Dict[int, str], custom_names: bool
-) -> None:
-    for i in range(install_count):  # 3
-        key: int = len(name_dict.keys()) + 1
-        if custom_names:
-            assign_custom_name(key, name_dict)
-        else:
-            name_dict[key] = str(len(name_dict) + 1)
-
-
-def get_install_count_and_name_dict(
-    klipper_list: List[Klipper], moonraker_list: List[Moonraker]
-) -> Tuple[int, Dict[int, str]]:
-    install_count: int | None
-    if len(moonraker_list) > len(klipper_list):
-        install_count = len(moonraker_list)
-        name_dict = {i: moonraker.suffix for i, moonraker in enumerate(moonraker_list)}
-    else:
-        install_count = get_install_count()
-        name_dict = {i: klipper.suffix for i, klipper in enumerate(klipper_list)}
-
-        if install_count is None:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return 0, {}
-
-    return install_count, name_dict
-
-
-def setup_klipper_prerequesites() -> None:
-    settings = KiauhSettings()
-    repo = settings.klipper.repo_url
-    branch = settings.klipper.branch
-
-    git_clone_wrapper(repo, KLIPPER_DIR, branch)
-
-    # install klipper dependencies and create python virtualenv
-    try:
-        install_klipper_packages()
-        if create_python_venv(KLIPPER_ENV_DIR):
-            install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
-    except Exception:
-        Logger.print_error("Error during installation of Klipper requirements!")
-        raise
-
-
-def install_klipper_packages() -> None:
-    script = KLIPPER_INSTALL_SCRIPT
-    packages = parse_packages_from_file(script)
-
-    # Add dbus requirement for DietPi distro
-    if Path("/boot/dietpi/.version").exists():
-        packages.append("dbus")
-
-    check_install_dependencies({*packages})
-
-
-def update_klipper() -> None:
-    Logger.print_dialog(
-        DialogType.WARNING,
-        [
-            "Do NOT continue if there are ongoing prints running!",
-            "All Klipper instances will be restarted during the update process and "
-            "ongoing prints WILL FAIL.",
-        ],
-    )
-
-    if not get_confirm("Update Klipper now?"):
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_klipper_dir()
-
-    instances = get_instances(Klipper)
-    InstanceManager.stop_all(instances)
-
-    git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
-
-    # install possible new system packages
-    install_klipper_packages()
-    # install possible new python dependencies
-    install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
-
-    InstanceManager.start_all(instances)
-
-
-def use_custom_names_or_go_back() -> bool | None:
-    print_select_custom_name_dialog()
-    _input: bool | None = get_confirm(
-        "Assign custom names?",
-        False,
-        allow_go_back=True,
-    )
-    return _input
-
-
-def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
-    # todo: only show the klipper instances that are not already installed
-    Logger.print_dialog(
-        DialogType.INFO,
-        [
-            "Existing Moonraker instances detected:",
-            *[f"● {m.service_file_path.stem}" for m in moonraker_list],
-            "\n\n",
-            "The following Klipper instances will be installed:",
-            *[f"● klipper-{m.suffix}" for m in moonraker_list],
-        ],
-    )
-    _input: bool = get_confirm("Proceed with installation?")
-    return _input

kiauh/components/klipper/klipper_utils.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -11,13 +11,14 @@ from __future__ import annotations
 import grp
 import os
 import shutil
+from pathlib import Path
 from subprocess import CalledProcessError, run
 from typing import Dict, List
 
 from components.klipper import (
-    KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
+    KLIPPER_INSTALL_SCRIPT,
     MODULE_PATH,
 )
 from components.klipper.klipper import Klipper
@@ -29,18 +30,23 @@ from components.webui_client.base_data import BaseWebClient
 from components.webui_client.client_config.client_config_setup import (
     create_client_config_symlink,
 )
-from core.backup_manager.backup_manager import BackupManager
 from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from core.types import ComponentStatus
-from utils.common import get_install_status
+from core.types.component_status import ComponentStatus
+from utils.common import check_install_dependencies, get_install_status
+from utils.fs_utils import check_file_exist
 from utils.input_utils import get_confirm, get_number_input, get_string_input
 from utils.instance_utils import get_instances
-from utils.sys_utils import cmd_sysctl_service
+from utils.sys_utils import (
+    cmd_sysctl_service,
+    install_python_packages,
+    parse_packages_from_file,
+)
 
 
 def get_klipper_status() -> ComponentStatus:
@@ -191,6 +197,65 @@ def create_example_printer_cfg(
 
 
 def backup_klipper_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory("klipper", source=KLIPPER_DIR, target=KLIPPER_BACKUP_DIR)
-    bm.backup_directory("klippy-env", source=KLIPPER_ENV_DIR, target=KLIPPER_BACKUP_DIR)
+    svc = BackupService()
+    svc.backup_directory(
+        source_path=KLIPPER_DIR,
+        backup_name="klipper",
+        target_path="klipper",
+    )
+    svc.backup_directory(
+        source_path=KLIPPER_ENV_DIR,
+        backup_name="klippy-env",
+        target_path="klipper",
+    )
+
+
+def install_klipper_packages() -> None:
+    script = KLIPPER_INSTALL_SCRIPT
+    packages = parse_packages_from_file(script)
+
+    # Add pkg-config for rp2040 build
+    packages.append("pkg-config")
+
+    # Add dbus requirement for DietPi distro
+    if check_file_exist(Path("/boot/dietpi/.version")):
+        packages.append("dbus")
+
+    check_install_dependencies({*packages})
+
+
+def install_input_shaper_deps() -> None:
+    if not KLIPPER_ENV_DIR.exists():
+        Logger.print_warn("Required Klipper python environment not found!")
+        return
+
+    Logger.print_dialog(
+        DialogType.CUSTOM,
+        [
+            "Resonance measurements and shaper auto-calibration require additional "
+            "software dependencies which are not installed by default. "
+            "If you agree, the following additional system packages will be installed:",
+            "● python3-numpy",
+            "● python3-matplotlib",
+            "● libopenblas-dev",
+            "\n\n",
+            "Also, the following Python package will be installed:",
+            "● numpy",
+        ],
+        custom_title="Install Input Shaper Dependencies",
+    )
+    if not get_confirm(
+        "Do you want to install the required packages?", default_choice=False
+    ):
+        return
+
+    apt_deps = (
+        "python3-numpy",
+        "python3-matplotlib",
+        "libopenblas-dev",
+    )
+    check_install_dependencies({*apt_deps})
+
+    py_deps = ("numpy",)
+
+    install_python_packages(KLIPPER_ENV_DIR, {*py_deps})

kiauh/components/klipper/menus/klipper_remove_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -11,22 +11,28 @@ from __future__ import annotations
 import textwrap
 from typing import Type
 
-from components.klipper import klipper_remove
-from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
+from components.klipper.services.klipper_setup_service import KlipperSetupService
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
 class KlipperRemoveMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+
+        self.title = "Remove Klipper"
+        self.title_color = Color.RED
         self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.footer_type = FooterType.BACK
-        self.remove_klipper_service = False
-        self.remove_klipper_dir = False
-        self.remove_klipper_env = False
-        self.selection_state = False
+
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
+        self.select_state = False
+
+        self.klsvc = KlipperSetupService()
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
@@ -43,23 +49,19 @@ class KlipperRemoveMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ Remove Klipper ] "
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        checked = f"[{Color.apply('x', Color.CYAN)}]"
         unchecked = "[ ]"
-        o1 = checked if self.remove_klipper_service else unchecked
-        o2 = checked if self.remove_klipper_dir else unchecked
-        o3 = checked if self.remove_klipper_env else unchecked
+        o1 = checked if self.rm_svc else unchecked
+        o2 = checked if self.rm_dir else unchecked
+        o3 = checked if self.rm_env else unchecked
+        sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ Enter a number and hit enter to select / deselect     ║
             ║ the specific option for removal.                      ║
             ╟───────────────────────────────────────────────────────╢
-            ║  a) {self._get_selection_state_str():37}             ║
+            ║  a) {sel_state:49} ║
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove Service                                ║
             ║  2) {o2} Remove Local Repository                       ║
@@ -72,47 +74,29 @@ class KlipperRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.selection_state = not self.selection_state
-        self.remove_klipper_service = self.selection_state
-        self.remove_klipper_dir = self.selection_state
-        self.remove_klipper_env = self.selection_state
+        self.select_state = not self.select_state
+        self.rm_svc = self.select_state
+        self.rm_dir = self.select_state
+        self.rm_env = self.select_state
 
     def toggle_remove_klipper_service(self, **kwargs) -> None:
-        self.remove_klipper_service = not self.remove_klipper_service
+        self.rm_svc = not self.rm_svc
 
     def toggle_remove_klipper_dir(self, **kwargs) -> None:
-        self.remove_klipper_dir = not self.remove_klipper_dir
+        self.rm_dir = not self.rm_dir
 
     def toggle_remove_klipper_env(self, **kwargs) -> None:
-        self.remove_klipper_env = not self.remove_klipper_env
+        self.rm_env = not self.rm_env
 
     def run_removal_process(self, **kwargs) -> None:
-        if (
-            not self.remove_klipper_service
-            and not self.remove_klipper_dir
-            and not self.remove_klipper_env
-        ):
-            error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
-            print(error)
+        if not self.rm_svc and not self.rm_dir and not self.rm_env:
+            msg = "Nothing selected! Select options to remove first."
+            print(Color.apply(msg, Color.RED))
             return
 
-        klipper_remove.run_klipper_removal(
-            self.remove_klipper_service,
-            self.remove_klipper_dir,
-            self.remove_klipper_env,
-        )
+        self.klsvc.remove(self.rm_svc, self.rm_dir, self.rm_env)
 
-        self.remove_klipper_service = False
-        self.remove_klipper_dir = False
-        self.remove_klipper_env = False
-
-        self._go_back()
-
-    def _get_selection_state_str(self) -> str:
-        return (
-            "Select everything" if not self.selection_state else "Deselect everything"
-        )
-
-    def _go_back(self, **kwargs) -> None:
-        if self.previous_menu is not None:
-            self.previous_menu().run()
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
+        self.select_state = False

kiauh/components/klipper/services/klipper_instance_service.py

@@ -0,0 +1,46 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from typing import List
+
+from components.klipper.klipper import Klipper
+from utils.instance_utils import get_instances
+
+
+class KlipperInstanceService:
+    __cls_instance = None
+    __instances: List[Klipper] = []
+
+    def __new__(cls) -> "KlipperInstanceService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(KlipperInstanceService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+
+    def load_instances(self) -> None:
+        self.__instances = get_instances(Klipper)
+
+    def create_new_instance(self, suffix: str) -> Klipper:
+        instance = Klipper(suffix)
+        self.__instances.append(instance)
+        return instance
+
+    def get_all_instances(self) -> List[Klipper]:
+        return self.__instances
+
+    def get_instance_by_suffix(self, suffix: str) -> Klipper | None:
+        instances: List[Klipper] = [i for i in self.__instances if i.suffix == suffix]
+        return instances[0] if instances else None

kiauh/components/klipper/services/klipper_setup_service.py

@@ -0,0 +1,366 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from copy import copy
+from typing import Dict, List, Tuple
+
+from components.klipper import (
+    EXIT_KLIPPER_SETUP,
+    KLIPPER_DIR,
+    KLIPPER_ENV_DIR,
+    KLIPPER_REPO_URL,
+    KLIPPER_REQ_FILE,
+)
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import (
+    print_instance_overview,
+    print_select_custom_name_dialog,
+)
+from components.klipper.klipper_utils import (
+    assign_custom_name,
+    backup_klipper_dir,
+    check_user_groups,
+    create_example_printer_cfg,
+    get_install_count,
+    handle_disruptive_system_packages,
+    install_klipper_packages,
+)
+from components.klipper.services.klipper_instance_service import KlipperInstanceService
+from components.moonraker.moonraker import Moonraker
+from components.moonraker.services.moonraker_instance_service import (
+    MoonrakerInstanceService,
+)
+from components.webui_client.client_utils import (
+    get_existing_clients,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.services.message_service import Message, MessageService
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
+from utils.fs_utils import run_remove_routines
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm, get_selection_input
+from utils.sys_utils import (
+    cmd_sysctl_manage,
+    create_python_venv,
+    install_python_requirements,
+    unit_file_exists,
+)
+
+
+# noinspection PyMethodMayBeStatic
+class KlipperSetupService:
+    __cls_instance = None
+
+    kisvc: KlipperInstanceService
+    misvc: MoonrakerInstanceService
+    msgsvc = MessageService
+
+    settings: KiauhSettings
+    klipper_list: List[Klipper]
+    moonraker_list: List[Moonraker]
+
+    def __new__(cls) -> "KlipperSetupService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(KlipperSetupService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+        self.__init_state()
+
+    def __init_state(self) -> None:
+        self.settings = KiauhSettings()
+
+        self.kisvc = KlipperInstanceService()
+        self.kisvc.load_instances()
+        self.klipper_list = self.kisvc.get_all_instances()
+
+        self.misvc = MoonrakerInstanceService()
+        self.misvc.load_instances()
+        self.moonraker_list = self.misvc.get_all_instances()
+
+        self.msgsvc = MessageService()
+
+    def __refresh_state(self) -> None:
+        self.kisvc.load_instances()
+        self.klipper_list = self.kisvc.get_all_instances()
+
+        self.misvc.load_instances()
+        self.moonraker_list = self.misvc.get_all_instances()
+
+    def install(self) -> None:
+        self.__refresh_state()
+
+        Logger.print_status("Installing Klipper ...")
+
+        match_moonraker: bool = False
+
+        # if there are more moonraker instances than klipper instances, ask the user to
+        # match the klipper instance count to the count of moonraker instances with the same suffix
+        if len(self.moonraker_list) > len(self.klipper_list):
+            is_confirmed = self.__display_moonraker_info()
+            if not is_confirmed:
+                Logger.print_status(EXIT_KLIPPER_SETUP)
+                return
+            match_moonraker = True
+
+        install_count, name_dict = self.__get_install_count_and_name_dict()
+
+        if install_count == 0:
+            Logger.print_status(EXIT_KLIPPER_SETUP)
+            return
+
+        is_multi_install = install_count > 1 or (
+            len(name_dict) >= 1 and install_count >= 1
+        )
+        if not name_dict and install_count == 1:
+            name_dict = {0: ""}
+        elif is_multi_install and not match_moonraker:
+            custom_names = self.__use_custom_names_or_go_back()
+            if custom_names is None:
+                Logger.print_status(EXIT_KLIPPER_SETUP)
+                return
+
+            self.__handle_instance_names(install_count, name_dict, custom_names)
+
+        create_example_cfg = get_confirm("Create example printer.cfg?")
+        # run the actual installation
+        try:
+            self.__run_setup(name_dict, create_example_cfg)
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Klipper installation failed!")
+            return
+
+    def update(self) -> None:
+        Logger.print_dialog(
+            DialogType.WARNING,
+            [
+                "Do NOT continue if there are ongoing prints running!",
+                "All Klipper instances will be restarted during the update process and "
+                "ongoing prints WILL FAIL.",
+            ],
+        )
+
+        if not get_confirm("Update Klipper now?"):
+            return
+
+        self.__refresh_state()
+
+        if self.settings.kiauh.backup_before_update:
+            backup_klipper_dir()
+
+        InstanceManager.stop_all(self.klipper_list)
+        git_pull_wrapper(KLIPPER_DIR)
+        install_klipper_packages()
+        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+        InstanceManager.start_all(self.klipper_list)
+
+    def remove(
+        self,
+        remove_service: bool,
+        remove_dir: bool,
+        remove_env: bool,
+    ) -> None:
+        self.__refresh_state()
+
+        completion_msg = Message(
+            title="Klipper Removal Process completed",
+            color=Color.GREEN,
+        )
+
+        if remove_service:
+            Logger.print_status("Removing Klipper instances ...")
+            if self.klipper_list:
+                instances_to_remove = self.__get_instances_to_remove()
+                self.__remove_instances(instances_to_remove)
+                if instances_to_remove:
+                    instance_names = [
+                        i.service_file_path.stem for i in instances_to_remove
+                    ]
+                    txt = f"● Klipper instances removed: {', '.join(instance_names)}"
+                    completion_msg.text.append(txt)
+            else:
+                Logger.print_info("No Klipper Services installed! Skipped ...")
+
+        if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
+            completion_msg.text = [
+                "Some Klipper services are still installed:",
+                f"● '{KLIPPER_DIR}' was not removed, even though selected for removal.",
+                f"● '{KLIPPER_ENV_DIR}' was not removed, even though selected for removal.",
+            ]
+        else:
+            if remove_dir:
+                Logger.print_status("Removing Klipper local repository ...")
+                if run_remove_routines(KLIPPER_DIR):
+                    completion_msg.text.append("● Klipper local repository removed")
+            if remove_env:
+                Logger.print_status("Removing Klipper Python environment ...")
+                if run_remove_routines(KLIPPER_ENV_DIR):
+                    completion_msg.text.append("● Klipper Python environment removed")
+
+        if completion_msg.text:
+            completion_msg.text.insert(0, "The following actions were performed:")
+        else:
+            completion_msg.color = Color.YELLOW
+            completion_msg.centered = True
+            completion_msg.text = ["Nothing to remove."]
+
+        self.msgsvc.set_message(completion_msg)
+
+    def __get_install_count_and_name_dict(self) -> Tuple[int, Dict[int, str]]:
+        install_count: int | None
+        if len(self.moonraker_list) > len(self.klipper_list):
+            install_count = len(self.moonraker_list)
+            name_dict = {
+                i: moonraker.suffix for i, moonraker in enumerate(self.moonraker_list)
+            }
+        else:
+            install_count = get_install_count()
+            name_dict = {
+                i: klipper.suffix for i, klipper in enumerate(self.klipper_list)
+            }
+
+            if install_count is None:
+                Logger.print_status(EXIT_KLIPPER_SETUP)
+                return 0, {}
+
+        return install_count, name_dict
+
+    def __run_setup(self, name_dict: Dict[int, str], create_example_cfg: bool) -> None:
+        if not self.klipper_list:
+            self.__install_deps()
+
+        for i in name_dict:
+            # skip this iteration if there is already an instance with the name
+            if name_dict[i] in [n.suffix for n in self.klipper_list]:
+                continue
+
+            instance = Klipper(suffix=name_dict[i])
+            instance.create()
+            InstanceManager.enable(instance)
+
+            if create_example_cfg:
+                # if a client-config is installed, include it in the new example cfg
+                clients = get_existing_clients()
+                create_example_printer_cfg(instance, clients)
+
+            InstanceManager.start(instance)
+
+        cmd_sysctl_manage("daemon-reload")
+
+        # step 4: check/handle conflicting packages/services
+        handle_disruptive_system_packages()
+
+        # step 5: check for required group membership
+        check_user_groups()
+
+    def __install_deps(self) -> None:
+        default_repo = (KLIPPER_REPO_URL, "master")
+        repo = self.settings.klipper.repositories
+        # pull the first repo defined in kiauh.cfg or fallback to the official Klipper repo
+        repo, branch = (repo[0].url, repo[0].branch) if repo else default_repo
+        git_clone_wrapper(repo, KLIPPER_DIR, branch)
+
+        try:
+            install_klipper_packages()
+            if create_python_venv(KLIPPER_ENV_DIR, False, False, self.settings.klipper.use_python_binary):
+                install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+        except Exception:
+            Logger.print_error("Error during installation of Klipper requirements!")
+            raise
+
+    def __display_moonraker_info(self) -> bool:
+        # todo: only show the klipper instances that are not already installed
+        Logger.print_dialog(
+            DialogType.INFO,
+            [
+                "Existing Moonraker instances detected:",
+                *[f"● {m.service_file_path.stem}" for m in self.moonraker_list],
+                "\n\n",
+                "The following Klipper instances will be installed:",
+                *[f"● klipper-{m.suffix}" for m in self.moonraker_list],
+            ],
+        )
+        _input: bool = get_confirm("Proceed with installation?")
+        return _input
+
+    def __handle_instance_names(
+        self, install_count: int, name_dict: Dict[int, str], custom_names: bool
+    ) -> None:
+        for i in range(install_count):  # 3
+            key: int = len(name_dict.keys()) + 1
+            if custom_names:
+                assign_custom_name(key, name_dict)
+            else:
+                name_dict[key] = str(len(name_dict) + 1)
+
+    def __use_custom_names_or_go_back(self) -> bool | None:
+        print_select_custom_name_dialog()
+        _input: bool | None = get_confirm(
+            "Assign custom names?",
+            False,
+            allow_go_back=True,
+        )
+        return _input
+
+    def __get_instances_to_remove(self) -> List[Klipper] | None:
+        start_index = 1
+        curr_instances: List[Klipper] = self.klipper_list
+        instance_count = len(curr_instances)
+
+        options = [str(i + start_index) for i in range(instance_count)]
+        options.extend(["a", "b"])
+        instance_map = {options[i]: self.klipper_list[i] for i in range(instance_count)}
+
+        print_instance_overview(
+            self.klipper_list,
+            start_index=start_index,
+            show_index=True,
+            show_select_all=True,
+        )
+        selection = get_selection_input("Select Klipper instance to remove", options)
+
+        if selection == "b":
+            return None
+        elif selection == "a":
+            return copy(self.klipper_list)
+
+        return [instance_map[selection]]
+
+    def __remove_instances(
+        self,
+        instance_list: List[Klipper] | None,
+    ) -> None:
+        if not instance_list:
+            return
+
+        for instance in instance_list:
+            Logger.print_status(
+                f"Removing instance {instance.service_file_path.stem} ..."
+            )
+            InstanceManager.remove(instance)
+            self.__delete_klipper_env_file(instance)
+
+        self.__refresh_state()
+
+    def __delete_klipper_env_file(self, instance: Klipper):
+        Logger.print_status(f"Remove '{instance.env_file}'")
+        if not instance.env_file.exists():
+            msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
+            Logger.print_info(msg)
+            return
+        run_remove_routines(instance.env_file)

kiauh/components/klipper_firmware/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/klipper_firmware/firmware_utils.py

@@ -1,13 +1,22 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-
-from subprocess import PIPE, STDOUT, CalledProcessError, Popen, check_output, run
+import re
+from pathlib import Path
+from subprocess import (
+    DEVNULL,
+    PIPE,
+    STDOUT,
+    CalledProcessError,
+    Popen,
+    check_output,
+    run,
+)
 from typing import List
 
 from components.klipper import KLIPPER_DIR
@@ -32,16 +41,18 @@ def find_firmware_file() -> bool:
     f3 = "klipper.bin"
     f4 = "klipper.uf2"
     fw_file_exists: bool = (
-        target.joinpath(f1).exists() and target.joinpath(f2).exists()
-    ) or target.joinpath(f3).exists() or target.joinpath(f4).exists()
+        (target.joinpath(f1).exists() and target.joinpath(f2).exists())
+        or target.joinpath(f3).exists()
+        or target.joinpath(f4).exists()
+    )
 
     return target_exists and fw_file_exists
 
 
 def find_usb_device_by_id() -> List[str]:
     try:
-        command = "find /dev/serial/by-id/* 2>/dev/null"
-        output = check_output(command, shell=True, text=True)
+        command = "find /dev/serial/by-id/*"
+        output = check_output(command, shell=True, text=True, stderr=DEVNULL)
         return output.splitlines()
     except CalledProcessError as e:
         Logger.print_error("Unable to find a USB device!")
@@ -51,9 +62,14 @@ def find_usb_device_by_id() -> List[str]:
 
 def find_uart_device() -> List[str]:
     try:
-        command = '"find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null"'
-        output = check_output(command, shell=True, text=True)
-        return output.splitlines()
+        cmd = "find /dev -maxdepth 1"
+        output = check_output(cmd, shell=True, text=True, stderr=DEVNULL)
+        device_list = []
+        if output:
+            pattern = r"^/dev/tty(AMA0|S0)$"
+            devices = output.splitlines()
+            device_list = [d for d in devices if re.search(pattern, d)]
+        return device_list
     except CalledProcessError as e:
         Logger.print_error("Unable to find a UART device!")
         Logger.print_error(e, prefix=False)
@@ -62,15 +78,34 @@ def find_uart_device() -> List[str]:
 
 def find_usb_dfu_device() -> List[str]:
     try:
-        command = '"lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null"'
-        output = check_output(command, shell=True, text=True)
-        return output.splitlines()
+        output = check_output("lsusb", shell=True, text=True, stderr=DEVNULL)
+        device_list = []
+        if output:
+            devices = output.splitlines()
+            device_list = [d.split(" ")[5] for d in devices if "DFU" in d]
+        return device_list
+
     except CalledProcessError as e:
         Logger.print_error("Unable to find a USB DFU device!")
         Logger.print_error(e, prefix=False)
         return []
 
 
+def find_usb_rp2_boot_device() -> List[str]:
+    try:
+        output = check_output("lsusb", shell=True, text=True, stderr=DEVNULL)
+        device_list = []
+        if output:
+            devices = output.splitlines()
+            device_list = [d.split(" ")[5] for d in devices if "RP2 Boot" in d]
+        return device_list
+
+    except CalledProcessError as e:
+        Logger.print_error("Unable to find a USB RP2 Boot device!")
+        Logger.print_error(e, prefix=False)
+        return []
+
+
 def get_sd_flash_board_list() -> List[str]:
     if not KLIPPER_DIR.exists() or not SD_FLASH_SCRIPT.exists():
         return []
@@ -104,6 +139,7 @@ def start_flash_process(flash_options: FlashOptions) -> None:
         if flash_options.flash_method is FlashMethod.REGULAR:
             cmd = [
                 "make",
+                f"KCONFIG_CONFIG={flash_options.selected_kconfig}",
                 flash_options.flash_command.value,
                 f"FLASH_DEVICE={flash_options.selected_mcu}",
             ]
@@ -131,17 +167,17 @@ def start_flash_process(flash_options: FlashOptions) -> None:
         if rc != 0:
             raise Exception(f"Flashing failed with returncode: {rc}")
         else:
-            Logger.print_ok("Flashing successfull!", start="\n", end="\n\n")
+            Logger.print_ok("Flashing successful!", start="\n", end="\n\n")
 
     except (Exception, CalledProcessError):
         Logger.print_error("Flashing failed!", start="\n")
         Logger.print_error("See the console output above!", end="\n\n")
 
 
-def run_make_clean() -> None:
+def run_make_clean(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
     try:
         run(
-            "make clean",
+            f"make KCONFIG_CONFIG={kconfig} clean",
             cwd=KLIPPER_DIR,
             shell=True,
             check=True,
@@ -151,10 +187,10 @@ def run_make_clean() -> None:
         raise
 
 
-def run_make_menuconfig() -> None:
+def run_make_menuconfig(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
     try:
         run(
-            "make PYTHON=python3 menuconfig",
+            f"make PYTHON=python3 KCONFIG_CONFIG={kconfig} menuconfig",
             cwd=KLIPPER_DIR,
             shell=True,
             check=True,
@@ -164,10 +200,10 @@ def run_make_menuconfig() -> None:
         raise
 
 
-def run_make() -> None:
+def run_make(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
     try:
         run(
-            "make PYTHON=python3",
+            f"make PYTHON=python3 KCONFIG_CONFIG={kconfig}",
             cwd=KLIPPER_DIR,
             shell=True,
             check=True,

kiauh/components/klipper_firmware/flash_options.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -26,6 +26,7 @@ class FlashCommand(Enum):
 class ConnectionType(Enum):
     USB = "USB"
     USB_DFU = "USB (DFU)"
+    USB_RP2040 = "USB (RP2040)"
     UART = "UART"
 
 
@@ -38,6 +39,7 @@ class FlashOptions:
     _selected_mcu: str = ""
     _selected_board: str = ""
     _selected_baudrate: int = 250000
+    _selected_kconfig: str = ".config"
 
     def __new__(cls, *args, **kwargs):
         if not cls._instance:
@@ -103,3 +105,11 @@ class FlashOptions:
     @selected_baudrate.setter
     def selected_baudrate(self, value: int) -> None:
         self._selected_baudrate = value
+
+    @property
+    def selected_kconfig(self) -> str:
+        return self._selected_kconfig
+
+    @selected_kconfig.setter
+    def selected_kconfig(self, value: str) -> None:
+        self._selected_kconfig = value

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -9,18 +9,22 @@
 from __future__ import annotations
 
 import textwrap
+from pathlib import Path
+from shutil import copyfile
 from typing import List, Set, Type
 
-from components.klipper import KLIPPER_DIR
+from components.klipper import KLIPPER_DIR, KLIPPER_KCONFIGS_DIR
 from components.klipper_firmware.firmware_utils import (
     run_make,
     run_make_clean,
     run_make_menuconfig,
 )
-from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
-from core.logger import Logger
+from components.klipper_firmware.flash_options import FlashOptions
+from core.logger import DialogType, Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
+from utils.input_utils import get_confirm, get_string_input
 from utils.sys_utils import (
     check_package_install,
     install_system_packages,
@@ -30,12 +34,110 @@ from utils.sys_utils import (
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
-class KlipperBuildFirmwareMenu(BaseMenu):
+class KlipperKConfigMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "Firmware Config Menu"
+        self.title_color = Color.CYAN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
-        self.missing_deps: List[str] = check_package_install(self.deps)
+        self.flash_options = FlashOptions()
+        self.kconfigs_dirname = KLIPPER_KCONFIGS_DIR
+        self.kconfig_default = KLIPPER_DIR.joinpath(".config")
+        self.configs: List[Path] = []
+        self.kconfig = (
+            self.kconfig_default if not Path(self.kconfigs_dirname).is_dir() else None
+        )
+
+    def run(self) -> None:
+        if not self.kconfig:
+            super().run()
+        else:
+            self.flash_options.selected_kconfig = self.kconfig
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.advanced_menu import AdvancedMenu
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else AdvancedMenu
+        )
+
+    def set_options(self) -> None:
+        if not Path(self.kconfigs_dirname).is_dir():
+            return
+
+        self.input_label_txt = "Select config or action to continue (default=N)"
+        self.default_option = Option(
+            method=self.select_config, opt_data=self.kconfig_default
+        )
+
+        option_index = 1
+        for kconfig in Path(self.kconfigs_dirname).iterdir():
+            if not kconfig.name.endswith(".config"):
+                continue
+            kconfig_path = self.kconfigs_dirname.joinpath(kconfig)
+            if Path(kconfig_path).is_file():
+                self.configs += [kconfig]
+                self.options[str(option_index)] = Option(
+                    method=self.select_config, opt_data=kconfig_path
+                )
+                option_index += 1
+        self.options["n"] = Option(
+            method=self.select_config, opt_data=self.kconfig_default
+        )
+
+    def print_menu(self) -> None:
+        cfg_found_str = Color.apply(
+            "Previously saved firmware configs found!", Color.GREEN
+        )
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {cfg_found_str:^62} ║
+            ║                                                       ║
+            ║    Select an existing config or create a new one.     ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Available firmware configs:                           ║
+            """
+        )[1:]
+
+        start_index = 1
+        for i, s in enumerate(self.configs):
+            line = f"{start_index + i}) {s.name}"
+            menu += f"║ {line:<54}║\n"
+
+        new_config = Color.apply("N) Create new firmware config", Color.GREEN)
+        menu += "║                                                       ║\n"
+        menu += f"║ {new_config:<62} ║\n"
+
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+
+        print(menu, end="")
+
+    def select_config(self, **kwargs) -> None:
+        selection: str | None = kwargs.get("opt_data", None)
+        if selection is None:
+            raise Exception("opt_data is None")
+        if not Path(selection).is_file() and selection != self.kconfig_default:
+            raise Exception("opt_data does not exists")
+        self.kconfig = selection
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperBuildFirmwareMenu(BaseMenu):
+    def __init__(
+        self, kconfig: str | None = None, previous_menu: Type[BaseMenu] | None = None
+    ):
+        super().__init__()
+        self.title = "Build Firmware Menu"
+        self.title_color = Color.CYAN
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
+        self.missing_deps: List[str] = check_package_install(self.deps)
+        self.flash_options = FlashOptions()
+        self.kconfigs_dirname = KLIPPER_KCONFIGS_DIR
+        self.kconfig_default = KLIPPER_DIR.joinpath(".config")
+        self.kconfig = self.flash_options.selected_kconfig
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.advanced_menu import AdvancedMenu
@@ -45,21 +147,22 @@ class KlipperBuildFirmwareMenu(BaseMenu):
         )
 
     def set_options(self) -> None:
-        if len(self.missing_deps) == 0:
-            self.input_label_txt = "Press ENTER to continue"
-            self.default_option = Option(method=self.start_build_process)
-        else:
         self.input_label_txt = "Press ENTER to install dependencies"
         self.default_option = Option(method=self.install_missing_deps)
 
+    def run(self):
+        # immediately start the build process if all dependencies are met
+        if len(self.missing_deps) == 0:
+            self.start_build_process()
+        else:
+            super().run()
+
     def print_menu(self) -> None:
-        header = " [ Build Firmware Menu ] "
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
+        txt = Color.apply("Dependencies are missing!", Color.RED)
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {txt:^62} ║
             ╟───────────────────────────────────────────────────────╢
             ║ The following dependencies are required:              ║
             ║                                                       ║
@@ -67,20 +170,14 @@ class KlipperBuildFirmwareMenu(BaseMenu):
         )[1:]
 
         for d in self.deps:
-            status_ok = f"{COLOR_GREEN}*INSTALLED*{RESET_FORMAT}"
-            status_missing = f"{COLOR_RED}*MISSING*{RESET_FORMAT}"
+            status_ok = Color.apply("*INSTALLED*", Color.GREEN)
+            status_missing = Color.apply("*MISSING*", Color.RED)
             status = status_missing if d in self.missing_deps else status_ok
-            padding = 39 - len(d) + len(status) + (len(status_ok) - len(status))
-            d = f" {COLOR_CYAN}● {d}{RESET_FORMAT}"
+            padding = 40 - len(d) + len(status) + (len(status_ok) - len(status))
+            d = Color.apply(f"● {d}", Color.CYAN)
             menu += f"║ {d}{status:>{padding}} ║\n"
+
         menu += "║                                                       ║\n"
-
-        if len(self.missing_deps) == 0:
-            line = f"{COLOR_GREEN}All dependencies are met!{RESET_FORMAT}"
-        else:
-            line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
-
-        menu += f"║ {line:<62} ║\n"
         menu += "╟───────────────────────────────────────────────────────╢\n"
 
         print(menu, end="")
@@ -99,13 +196,16 @@ class KlipperBuildFirmwareMenu(BaseMenu):
 
     def start_build_process(self, **kwargs) -> None:
         try:
-            run_make_clean()
-            run_make_menuconfig()
-            run_make()
+            run_make_clean(self.kconfig)
+            run_make_menuconfig(self.kconfig)
+            run_make(self.kconfig)
 
             Logger.print_ok("Firmware successfully built!")
             Logger.print_ok(f"Firmware file located in '{KLIPPER_DIR}/out'!")
 
+            if self.kconfig == self.kconfig_default:
+                self.save_firmware_config()
+
         except Exception as e:
             Logger.print_error(e)
             Logger.print_error("Building Klipper Firmware failed!")
@@ -113,3 +213,62 @@ class KlipperBuildFirmwareMenu(BaseMenu):
         finally:
             if self.previous_menu is not None:
                 self.previous_menu().run()
+
+    def save_firmware_config(self) -> None:
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            [
+                "You can save the firmware build configs for multiple MCUs,"
+                " and use them to update the firmware after a Klipper version upgrade"
+            ],
+            custom_title="Save firmware config",
+        )
+        if not get_confirm(
+            "Do you want to save firmware config?", default_choice=False
+        ):
+            return
+
+        filename = self.kconfig_default
+        while True:
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                [
+                    "Allowed characters: a-z, 0-9 and '-'",
+                    "The name must not contain the following:",
+                    "\n\n",
+                    "● Any special characters",
+                    "● No leading or trailing '-'",
+                ],
+            )
+            input_name = get_string_input(
+                "Enter the new firmware config name",
+                regex=r"^[a-z0-9]+([a-z0-9-]*[a-z0-9])?$",
+            )
+            filename = self.kconfigs_dirname.joinpath(f"{input_name}.config")
+
+            if Path(filename).is_file():
+                if get_confirm(
+                    f"Firmware config {input_name} already exists, overwrite?",
+                    default_choice=False,
+                ):
+                    break
+
+            if Path(filename).is_dir():
+                Logger.print_error(f"Path {filename} exists and it's a directory")
+
+            if not Path(filename).exists():
+                break
+
+        if not get_confirm(
+            f"Save firmware config to '{filename}'?", default_choice=True
+        ):
+            Logger.print_info("Aborted saving firmware config ...")
+            return
+
+        if not Path(self.kconfigs_dirname).exists():
+            Path(self.kconfigs_dirname).mkdir()
+
+        copyfile(self.kconfig_default, filename)
+
+        Logger.print_ok()
+        Logger.print_ok(f"Firmware config successfully saved to {filename}")

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -12,9 +12,9 @@ import textwrap
 from typing import Type
 
 from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
-from core.constants import COLOR_RED, RESET_FORMAT
 from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
@@ -22,6 +22,9 @@ from core.menus.base_menu import BaseMenu
 class KlipperNoFirmwareErrorMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "!!! NO FIRMWARE FILE FOUND !!!"
+        self.title_color = Color.RED
+        self.title_style = MenuTitleStyle.PLAIN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
         self.flash_options = FlashOptions()
@@ -35,16 +38,11 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
         self.default_option = Option(method=self.go_back)
 
     def print_menu(self) -> None:
-        header = "!!! NO FIRMWARE FILE FOUND !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        line1 = f"{color}Unable to find a compiled firmware file!{RESET_FORMAT}"
+        line1 = "Unable to find a compiled firmware file!"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
-            ║ {line1:<62} ║
+            ║ {Color.apply(line1, Color.RED):<62} ║
             ║                                                       ║
             ║ Make sure, that:                                      ║
             ║ ● the folder '~/klipper/out' and its content exist    ║
@@ -71,6 +69,9 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
 class KlipperNoBoardTypesErrorMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "!!! ERROR GETTING BOARD LIST !!!"
+        self.title_color = Color.RED
+        self.title_style = MenuTitleStyle.PLAIN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.footer_type = FooterType.BLANK
         self.input_label_txt = "Press ENTER to go back to [Main Menu]"
@@ -82,16 +83,11 @@ class KlipperNoBoardTypesErrorMenu(BaseMenu):
         self.default_option = Option(method=self.go_back)
 
     def print_menu(self) -> None:
-        header = "!!! ERROR GETTING BOARD LIST !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        line1 = f"{color}Reading the list of supported boards failed!{RESET_FORMAT}"
+        line1 = "Reading the list of supported boards failed!"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
-            ║ {line1:<62} ║
+            ║ {Color.apply(line1, Color.RED):<62} ║
             ║                                                       ║
             ║ Make sure, that:                                      ║
             ║ ● the folder '~/klipper' and all its content exist    ║

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -9,16 +9,21 @@
 from __future__ import annotations
 
 import textwrap
-from typing import Type
+from typing import Tuple, Type
 
-from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
+
+
+def __title_config__() -> Tuple[str, Color, MenuTitleStyle]:
+    return "< ? > Help: Flash MCU < ? >", Color.YELLOW, MenuTitleStyle.PLAIN
 
 
 # noinspection DuplicatedCode
 class KlipperFlashMethodHelpMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title, self.title_color, self.title_style = __title_config__()
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -34,15 +39,10 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
         pass
 
     def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
+        subheader1 = Color.apply("Regular flashing method:", Color.CYAN)
+        subheader2 = Color.apply("Updating via SD-Card Update:", Color.CYAN)
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ {subheader1:<62} ║
             ║ The default method to flash controller boards which   ║
@@ -77,6 +77,7 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
 class KlipperFlashCommandHelpMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title, self.title_color, self.title_style = __title_config__()
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -92,15 +93,10 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
         pass
 
     def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
+        subheader1 = Color.apply("make flash:", Color.CYAN)
+        subheader2 = Color.apply("make serialflash:", Color.CYAN)
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ {subheader1:<62} ║
             ║ The default command to flash controller board, it     ║
@@ -121,6 +117,7 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
 class KlipperMcuConnectionHelpMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title, self.title_color, self.title_style = __title_config__()
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -138,15 +135,12 @@ class KlipperMcuConnectionHelpMenu(BaseMenu):
         pass
 
     def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
+        subheader1 = Color.apply("USB:", Color.CYAN)
+        subheader2 = Color.apply("UART:", Color.CYAN)
+        subheader3 = Color.apply("USB DFU:", Color.CYAN)
+        subheader4 = Color.apply("USB RP2040 Boot:", Color.CYAN)
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ {subheader1:<62} ║
             ║ Selecting USB as the connection method will scan the  ║
@@ -164,6 +158,19 @@ class KlipperMcuConnectionHelpMenu(BaseMenu):
             ║ port your controller board is connected to when using ║
             ║ this connection method.                               ║
             ║                                                       ║
+            ║ {subheader3:<62} ║
+            ║ Selecting USB DFU as the connection method will scan  ║
+            ║ the USB ports for connected controller boards in      ║
+            ║ STM32 DFU mode, which is usually done by holding down ║
+            ║ the BOOT button or setting a special jumper on the    ║
+            ║ board before powering up.                             ║
+            ║                                                       ║
+            ║ {subheader4:<62} ║
+            ║ Selecting USB RP2 Boot as the connection method will  ║
+            ║ scan the USB ports for connected RP2040 controller    ║
+            ║ boards in Boot mode, which is usually done by holding ║
+            ║ down the BOOT button before powering up.              ║
+            ║                                                       ║
             ╟───────────────────────────────────────────────────────╢
             """
         )[1:]

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -10,6 +10,7 @@ from __future__ import annotations
 
 import textwrap
 import time
+from pathlib import Path
 from typing import Type
 
 from components.klipper_firmware.firmware_utils import (
@@ -17,6 +18,7 @@ from components.klipper_firmware.firmware_utils import (
     find_uart_device,
     find_usb_device_by_id,
     find_usb_dfu_device,
+    find_usb_rp2_boot_device,
     get_sd_flash_board_list,
     start_flash_process,
 )
@@ -35,10 +37,10 @@ from components.klipper_firmware.menus.klipper_flash_help_menu import (
     KlipperFlashMethodHelpMenu,
     KlipperMcuConnectionHelpMenu,
 )
-from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
 from core.logger import DialogType, Logger
 from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
 from utils.input_utils import get_number_input
 
 
@@ -47,6 +49,8 @@ from utils.input_utils import get_number_input
 class KlipperFlashMethodMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "MCU Flash Menu"
+        self.title_color = Color.CYAN
         self.help_menu = KlipperFlashMethodHelpMenu
         self.input_label_txt = "Select flash method"
         self.footer_type = FooterType.BACK_HELP
@@ -66,17 +70,13 @@ class KlipperFlashMethodMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ MCU Flash Menu ] "
-        subheader = f"{COLOR_YELLOW}ATTENTION:{RESET_FORMAT}"
-        subline1 = f"{COLOR_YELLOW}Make sure to select the correct method for the  MCU!{RESET_FORMAT}"
-        subline2 = f"{COLOR_YELLOW}Not all MCUs support both methods!{RESET_FORMAT}"
-
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader = Color.apply("ATTENTION:", Color.YELLOW)
+        subline1 = Color.apply(
+            "Make sure to select the correct method for the MCU!", Color.YELLOW
+        )
+        subline2 = Color.apply("Not all MCUs support both methods!", Color.YELLOW)
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ Select the flash method for flashing the MCU.         ║
             ║                                                       ║
@@ -111,6 +111,9 @@ class KlipperFlashMethodMenu(BaseMenu):
 class KlipperFlashCommandMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "Which flash command to use for flashing the MCU?"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.YELLOW
         self.help_menu = KlipperFlashCommandHelpMenu
         self.input_label_txt = "Select flash command"
         self.footer_type = FooterType.BACK_HELP
@@ -131,8 +134,6 @@ class KlipperFlashCommandMenu(BaseMenu):
     def print_menu(self) -> None:
         menu = textwrap.dedent(
             """
-            ╔═══════════════════════════════════════════════════════╗
-            ║ Which flash command to use for flashing the MCU?      ║
             ╟───────────────────────────────────────────────────────╢
             ║ 1) make flash (default)                               ║
             ║ 2) make serialflash (stm32flash)                      ║
@@ -160,6 +161,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
         self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
     ):
         super().__init__()
+        self.title = "Make sure that the controller board is connected now!"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.YELLOW
         self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.__standalone = standalone
         self.help_menu = KlipperMcuConnectionHelpMenu
@@ -177,22 +181,19 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
             "1": Option(method=self.select_usb),
             "2": Option(method=self.select_dfu),
             "3": Option(method=self.select_usb_dfu),
+            "4": Option(method=self.select_usb_rp2040),
         }
 
     def print_menu(self) -> None:
-        header = "Make sure that the controller board is connected now!"
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            """
             ╟───────────────────────────────────────────────────────╢
             ║ How is the controller board connected to the host?    ║
             ╟───────────────────────────────────────────────────────╢
             ║ 1) USB                                                ║
             ║ 2) UART                                               ║
             ║ 3) USB (DFU mode)                                     ║
+            ║ 4) USB (RP2040 mode)                                  ║
             ╟───────────────────────────┬───────────────────────────╢
             """
         )[1:]
@@ -210,6 +211,10 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
         self.flash_options.connection_type = ConnectionType.USB_DFU
         self.get_mcu_list()
 
+    def select_usb_rp2040(self, **kwargs):
+        self.flash_options.connection_type = ConnectionType.USB_RP2040
+        self.get_mcu_list()
+
     def get_mcu_list(self, **kwargs):
         conn_type = self.flash_options.connection_type
 
@@ -222,6 +227,11 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
         elif conn_type is ConnectionType.USB_DFU:
             Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
             self.flash_options.mcu_list = find_usb_dfu_device()
+        elif conn_type is ConnectionType.USB_RP2040:
+            Logger.print_status(
+                "Identifying MCU connected via USB in RP2 Boot mode ..."
+            )
+            self.flash_options.mcu_list = find_usb_rp2_boot_device()
 
         if len(self.flash_options.mcu_list) < 1:
             Logger.print_warn("No MCUs found!")
@@ -231,7 +241,7 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
         if self.__standalone and len(self.flash_options.mcu_list) > 0:
             Logger.print_ok("The following MCUs were found:", prefix=False)
             for i, mcu in enumerate(self.flash_options.mcu_list):
-                print(f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}")
+                print(f"   ● MCU #{i}: {Color.CYAN}{mcu}{Color.RST}")
             time.sleep(3)
             return
 
@@ -246,6 +256,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
 class KlipperSelectMcuIdMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "!!! ATTENTION !!!"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.RED
         self.flash_options = FlashOptions()
         self.mcu_list = self.flash_options.mcu_list
         self.input_label_txt = "Select MCU to flash"
@@ -264,14 +277,9 @@ class KlipperSelectMcuIdMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = "!!! ATTENTION !!!"
-        header2 = f"[{COLOR_CYAN}List of detected MCUs{RESET_FORMAT}]"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
+        header2 = f"[{Color.apply('List of detected MCUs', Color.CYAN)}]"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ Make sure, to select the correct MCU!                 ║
             ║ ONLY flash a firmware created for the respective MCU! ║
@@ -283,7 +291,7 @@ class KlipperSelectMcuIdMenu(BaseMenu):
 
         for i, mcu in enumerate(self.mcu_list):
             mcu = mcu.split("/")[-1]
-            menu += f"║ {i}) {COLOR_CYAN}{mcu:<51}{RESET_FORMAT}║\n"
+            menu += f"║ {i}) {Color.apply(f'{mcu:<51}', Color.CYAN)}║\n"
 
         menu += textwrap.dedent(
             """
@@ -338,7 +346,6 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
         else:
             menu = textwrap.dedent(
                 """
-                ╔═══════════════════════════════════════════════════════╗
                 ║ Please select the type of board that corresponds to   ║
                 ║ the currently selected MCU ID you chose before.       ║
                 ║                                                       ║
@@ -379,7 +386,7 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
         self.flash_options.selected_baudrate = get_number_input(
             question="Please set the baud rate",
             default=250000,
-            min_count=0,
+            min_value=0,
             allow_go_back=True,
         )
         KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
@@ -390,6 +397,9 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 class KlipperFlashOverviewMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "!!! ATTENTION !!!"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.RED
         self.flash_options = FlashOptions()
         self.input_label_txt = "Perform action (default=Y)"
 
@@ -405,21 +415,17 @@ class KlipperFlashOverviewMenu(BaseMenu):
         self.default_option = Option(self.execute_flash)
 
     def print_menu(self) -> None:
-        header = "!!! ATTENTION !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-
         method = self.flash_options.flash_method.value
         command = self.flash_options.flash_command.value
         conn_type = self.flash_options.connection_type.value
         mcu = self.flash_options.selected_mcu.split("/")[-1]
         board = self.flash_options.selected_board
         baudrate = self.flash_options.selected_baudrate
-        subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
+        kconfig = Path(self.flash_options.selected_kconfig).name
+        color = Color.CYAN
+        subheader = f"[{Color.apply('Overview', color)}]"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ Before contuining the flashing process, please check  ║
             ║ if all parameters were set correctly! Once you made   ║
@@ -433,18 +439,25 @@ class KlipperFlashOverviewMenu(BaseMenu):
 
         menu += textwrap.dedent(
             f"""
-            ║ MCU: {COLOR_CYAN}{mcu:<48}{RESET_FORMAT} ║
-            ║ Connection: {COLOR_CYAN}{conn_type:<41}{RESET_FORMAT} ║
-            ║ Flash method: {COLOR_CYAN}{method:<39}{RESET_FORMAT} ║
-            ║ Flash command: {COLOR_CYAN}{command:<38}{RESET_FORMAT} ║
+            ║ MCU: {Color.apply(f"{mcu:<48}", color)} ║
+            ║ Connection: {Color.apply(f"{conn_type:<41}", color)} ║
+            ║ Flash method: {Color.apply(f"{method:<39}", color)} ║
+            ║ Flash command: {Color.apply(f"{command:<38}", color)} ║
             """
         )[1:]
 
         if self.flash_options.flash_method is FlashMethod.SD_CARD:
             menu += textwrap.dedent(
                 f"""
-                ║ Board type: {COLOR_CYAN}{board:<41}{RESET_FORMAT} ║
-                ║ Baudrate: {COLOR_CYAN}{baudrate:<43}{RESET_FORMAT} ║
+                ║ Board type: {Color.apply(f"{board:<41}", color)} ║
+                ║ Baudrate: {Color.apply(f"{baudrate:<43}", color)} ║
+                """
+            )[1:]
+
+        if self.flash_options.flash_method is FlashMethod.REGULAR:
+            menu += textwrap.dedent(
+                f"""
+                ║ Firmware config: {Color.apply(f"{kconfig:<36}", color)} ║
                 """
             )[1:]
 

kiauh/components/klipperscreen/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -8,7 +8,6 @@
 # ======================================================================= #
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -22,7 +21,6 @@ KLIPPERSCREEN_LOG_NAME = "KlipperScreen.log"
 # directories
 KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
 KLIPPERSCREEN_ENV_DIR = Path.home().joinpath(".KlipperScreen-env")
-KLIPPERSCREEN_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipperscreen-backups")
 
 # files
 KLIPPERSCREEN_REQ_FILE = KLIPPERSCREEN_DIR.joinpath(

kiauh/components/klipperscreen/klipperscreen.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -13,7 +13,6 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.klipperscreen import (
-    KLIPPERSCREEN_BACKUP_DIR,
     KLIPPERSCREEN_DIR,
     KLIPPERSCREEN_ENV_DIR,
     KLIPPERSCREEN_INSTALL_SCRIPT,
@@ -25,12 +24,12 @@ from components.klipperscreen import (
     KLIPPERSCREEN_UPDATER_SECTION_NAME,
 )
 from components.moonraker.moonraker import Moonraker
-from core.backup_manager.backup_manager import BackupManager
 from core.constants import SYSTEMD
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
-from core.types import ComponentStatus
+from core.types.component_status import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
@@ -97,6 +96,7 @@ def install_klipperscreen() -> None:
 
 
 def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
+    BackupService().backup_moonraker_conf()
     add_config_section(
         section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
         instances=instances,
@@ -126,7 +126,7 @@ def update_klipperscreen() -> None:
         if settings.kiauh.backup_before_update:
             backup_klipperscreen_dir()
 
-        git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
+        git_pull_wrapper(KLIPPERSCREEN_DIR)
 
         install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
 
@@ -183,6 +183,7 @@ def remove_klipperscreen() -> None:
         mr_instances: List[Moonraker] = get_instances(Moonraker)
         if mr_instances:
             Logger.print_status("Removing KlipperScreen from update manager ...")
+            BackupService().backup_moonraker_conf()
             remove_config_section("update_manager KlipperScreen", mr_instances)
             Logger.print_ok("KlipperScreen successfully removed from update manager!")
 
@@ -193,14 +194,14 @@ def remove_klipperscreen() -> None:
 
 
 def backup_klipperscreen_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory(
-        KLIPPERSCREEN_DIR.name,
-        source=KLIPPERSCREEN_DIR,
-        target=KLIPPERSCREEN_BACKUP_DIR,
+    svc = BackupService()
+    svc.backup_directory(
+        source_path=KLIPPERSCREEN_DIR,
+        backup_name="KlipperScreen",
+        target_path="KlipperScreen",
     )
-    bm.backup_directory(
-        KLIPPERSCREEN_ENV_DIR.name,
-        source=KLIPPERSCREEN_ENV_DIR,
-        target=KLIPPERSCREEN_BACKUP_DIR,
+    svc.backup_directory(
+        source_path=KLIPPERSCREEN_ENV_DIR,
+        backup_name="KlipperScreen-env",
+        target_path="KlipperScreen",
     )

kiauh/components/log_uploads/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/log_uploads/log_upload_utils.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -12,16 +12,18 @@ import textwrap
 from typing import Type
 
 from components.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
-from core.constants import COLOR_YELLOW, RESET_FORMAT
 from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 
 
 # noinspection PyMethodMayBeStatic
 class LogUploadMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+        self.title = "Log Upload"
+        self.title_color = Color.YELLOW
         self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.logfile_list = get_logfile_list()
 
@@ -37,13 +39,8 @@ class LogUploadMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ Log Upload ] "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            """
             ╟───────────────────────────────────────────────────────╢
             ║ You can select the following logfiles for uploading:  ║
             ║                                                       ║

kiauh/components/moonraker/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -9,10 +9,10 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 MODULE_PATH = Path(__file__).resolve().parent
 
+MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker.git"
+
 # names
 MOONRAKER_CFG_NAME = "moonraker.conf"
 MOONRAKER_LOG_NAME = "moonraker.log"
@@ -23,8 +23,6 @@ MOONRAKER_ENV_FILE_NAME = "moonraker.env"
 # directories
 MOONRAKER_DIR = Path.home().joinpath("moonraker")
 MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
-MOONRAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-backups")
-MOONRAKER_DB_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-db-backups")
 
 # files
 MOONRAKER_INSTALL_SCRIPT = MOONRAKER_DIR.joinpath("scripts/install-moonraker.sh")

kiauh/components/moonraker/assets/moonraker.conf

@@ -10,6 +10,7 @@ trusted_clients:
     169.254.0.0/16
     172.16.0.0/12
     192.168.0.0/16
+    FC00::/7
     FE80::/10
     ::1/128
 cors_domains:

kiauh/components/moonraker/menus/moonraker_remove_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -11,22 +11,29 @@ from __future__ import annotations
 import textwrap
 from typing import Type
 
-from components.moonraker import moonraker_remove
-from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
-from core.menus import Option
+from components.moonraker.services.moonraker_setup_service import MoonrakerSetupService
+from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
 class MoonrakerRemoveMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
+
+        self.title = "Remove Moonraker"
+        self.title_color = Color.RED
         self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.remove_moonraker_service = False
-        self.remove_moonraker_dir = False
-        self.remove_moonraker_env = False
-        self.remove_moonraker_polkit = False
-        self.selection_state = False
+        self.footer_type = FooterType.BACK
+
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
+        self.rm_pk = False
+        self.select_state = False
+
+        self.mrsvc = MoonrakerSetupService()
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
@@ -44,24 +51,20 @@ class MoonrakerRemoveMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ Remove Moonraker ] "
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        checked = f"[{Color.apply('x', Color.CYAN)}]"
         unchecked = "[ ]"
-        o1 = checked if self.remove_moonraker_service else unchecked
-        o2 = checked if self.remove_moonraker_dir else unchecked
-        o3 = checked if self.remove_moonraker_env else unchecked
-        o4 = checked if self.remove_moonraker_polkit else unchecked
+        o1 = checked if self.rm_svc else unchecked
+        o2 = checked if self.rm_dir else unchecked
+        o3 = checked if self.rm_env else unchecked
+        o4 = checked if self.rm_pk else unchecked
+        sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ Enter a number and hit enter to select / deselect     ║
             ║ the specific option for removal.                      ║
             ╟───────────────────────────────────────────────────────╢
-            ║  a) {self._get_selection_state_str():37}             ║
+            ║  a) {sel_state:49} ║
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove Service                                ║
             ║  2) {o2} Remove Local Repository                       ║
@@ -75,54 +78,33 @@ class MoonrakerRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.selection_state = not self.selection_state
-        self.remove_moonraker_service = self.selection_state
-        self.remove_moonraker_dir = self.selection_state
-        self.remove_moonraker_env = self.selection_state
-        self.remove_moonraker_polkit = self.selection_state
+        self.select_state = not self.select_state
+        self.rm_svc = self.select_state
+        self.rm_dir = self.select_state
+        self.rm_env = self.select_state
+        self.rm_pk = self.select_state
 
     def toggle_remove_moonraker_service(self, **kwargs) -> None:
-        self.remove_moonraker_service = not self.remove_moonraker_service
+        self.rm_svc = not self.rm_svc
 
     def toggle_remove_moonraker_dir(self, **kwargs) -> None:
-        self.remove_moonraker_dir = not self.remove_moonraker_dir
+        self.rm_dir = not self.rm_dir
 
     def toggle_remove_moonraker_env(self, **kwargs) -> None:
-        self.remove_moonraker_env = not self.remove_moonraker_env
+        self.rm_env = not self.rm_env
 
     def toggle_remove_moonraker_polkit(self, **kwargs) -> None:
-        self.remove_moonraker_polkit = not self.remove_moonraker_polkit
+        self.rm_pk = not self.rm_pk
 
     def run_removal_process(self, **kwargs) -> None:
-        if (
-            not self.remove_moonraker_service
-            and not self.remove_moonraker_dir
-            and not self.remove_moonraker_env
-            and not self.remove_moonraker_polkit
-        ):
-            error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
-            print(error)
+        if not self.rm_svc and not self.rm_dir and not self.rm_env and not self.rm_pk:
+            msg = "Nothing selected! Select options to remove first."
+            print(Color.apply(msg, Color.RED))
             return
 
-        moonraker_remove.run_moonraker_removal(
-            self.remove_moonraker_service,
-            self.remove_moonraker_dir,
-            self.remove_moonraker_env,
-            self.remove_moonraker_polkit,
-        )
+        self.mrsvc.remove(self.rm_svc, self.rm_dir, self.rm_env, self.rm_pk)
 
-        self.remove_moonraker_service = False
-        self.remove_moonraker_dir = False
-        self.remove_moonraker_env = False
-        self.remove_moonraker_polkit = False
-
-        self._go_back()
-
-    def _get_selection_state_str(self) -> str:
-        return (
-            "Select everything" if not self.selection_state else "Deselect everything"
-        )
-
-    def _go_back(self, **kwargs) -> None:
-        if self.previous_menu is not None:
-            self.previous_menu().run()
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
+        self.rm_pk = False

kiauh/components/moonraker/moonraker.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/moonraker/moonraker_dialogs.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -12,8 +12,8 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
-from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
 from core.menus.base_menu import print_back_footer
+from core.types.color import Color
 
 
 def print_moonraker_overview(
@@ -22,7 +22,7 @@ def print_moonraker_overview(
     show_index=False,
     show_select_all=False,
 ):
-    headline = f"{COLOR_GREEN}The following instances were found:{RESET_FORMAT}"
+    headline = Color.apply("The following instances were found:", Color.GREEN)
     dialog = textwrap.dedent(
         f"""
         ╔═══════════════════════════════════════════════════════╗
@@ -32,7 +32,7 @@ def print_moonraker_overview(
     )[1:]
 
     if show_select_all:
-        select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+        select_all = Color.apply("a) Select all", Color.YELLOW)
         dialog += f"║ {select_all:<63}║\n"
         dialog += "║                                                       ║\n"
 
@@ -48,12 +48,16 @@ def print_moonraker_overview(
     for i, k in enumerate(instance_map):
         mr_name = instance_map.get(k)
         m = f"<-> {mr_name}" if mr_name != "" else ""
-        line = f"{COLOR_CYAN}{f'{i+1})' if show_index else '●'} {k} {m} {RESET_FORMAT}"
+        line = Color.apply(f"{f'{i + 1})' if show_index else '●'} {k} {m}", Color.CYAN)
         dialog += f"║ {line:<63}║\n"
 
-    warn_l1 = f"{COLOR_YELLOW}PLEASE NOTE: {RESET_FORMAT}"
-    warn_l2 = f"{COLOR_YELLOW}If you select an instance with an existing Moonraker{RESET_FORMAT}"
-    warn_l3 = f"{COLOR_YELLOW}instance, that Moonraker instance will be re-created!{RESET_FORMAT}"
+    warn_l1 = Color.apply("PLEASE NOTE:", Color.YELLOW)
+    warn_l2 = Color.apply(
+        "If you select an instance with an existing Moonraker", Color.YELLOW
+    )
+    warn_l3 = Color.apply(
+        "instance, that Moonraker instance will be re-created!", Color.YELLOW
+    )
     warning = textwrap.dedent(
         f"""
         ║                                                       ║

kiauh/components/moonraker/moonraker_remove.py

@@ -1,121 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-from subprocess import DEVNULL, PIPE, CalledProcessError, run
-from typing import List
-
-from components.klipper.klipper_dialogs import print_instance_overview
-from components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR
-from components.moonraker.moonraker import Moonraker
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from utils.fs_utils import run_remove_routines
-from utils.input_utils import get_selection_input
-from utils.instance_utils import get_instances
-from utils.sys_utils import unit_file_exists
-
-
-def run_moonraker_removal(
-    remove_service: bool,
-    remove_dir: bool,
-    remove_env: bool,
-    remove_polkit: bool,
-) -> None:
-    instances = get_instances(Moonraker)
-
-    if remove_service:
-        Logger.print_status("Removing Moonraker instances ...")
-        if instances:
-            instances_to_remove = select_instances_to_remove(instances)
-            remove_instances(instances_to_remove)
-        else:
-            Logger.print_info("No Moonraker Services installed! Skipped ...")
-
-    delete_remaining: bool = remove_polkit or remove_dir or remove_env
-    if delete_remaining and unit_file_exists("moonraker", suffix="service"):
-        Logger.print_info("There are still other Moonraker services installed")
-        Logger.print_info(
-            "●  Moonraker PolicyKit rules were not removed.", prefix=False
-        )
-        Logger.print_info(f"● '{MOONRAKER_DIR}' was not removed.", prefix=False)
-        Logger.print_info(f"● '{MOONRAKER_ENV_DIR}' was not removed.", prefix=False)
-    else:
-        if remove_polkit:
-            Logger.print_status("Removing all Moonraker policykit rules ...")
-            remove_polkit_rules()
-        if remove_dir:
-            Logger.print_status("Removing Moonraker local repository ...")
-            run_remove_routines(MOONRAKER_DIR)
-        if remove_env:
-            Logger.print_status("Removing Moonraker Python environment ...")
-            run_remove_routines(MOONRAKER_ENV_DIR)
-
-
-def select_instances_to_remove(
-    instances: List[Moonraker],
-) -> List[Moonraker] | None:
-    start_index = 1
-    options = [str(i + start_index) for i in range(len(instances))]
-    options.extend(["a", "b"])
-    instance_map = {options[i]: instances[i] for i in range(len(instances))}
-
-    print_instance_overview(
-        instances,
-        start_index=start_index,
-        show_index=True,
-        show_select_all=True,
-    )
-    selection = get_selection_input("Select Moonraker instance to remove", options)
-
-    instances_to_remove = []
-    if selection == "b":
-        return None
-    elif selection == "a":
-        instances_to_remove.extend(instances)
-    else:
-        instances_to_remove.append(instance_map[selection])
-
-    return instances_to_remove
-
-
-def remove_instances(
-    instance_list: List[Moonraker] | None,
-) -> None:
-    if not instance_list:
-        Logger.print_info("No Moonraker instances found. Skipped ...")
-        return
-    for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
-        InstanceManager.remove(instance)
-        delete_moonraker_env_file(instance)
-
-
-def remove_polkit_rules() -> None:
-    if not MOONRAKER_DIR.exists():
-        log = "Cannot remove policykit rules. Moonraker directory not found."
-        Logger.print_warn(log)
-        return
-
-    try:
-        cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
-        run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
-    except CalledProcessError as e:
-        Logger.print_error(f"Error while removing policykit rules: {e}")
-
-    Logger.print_ok("Policykit rules successfully removed!")
-
-
-def delete_moonraker_env_file(instance: Moonraker):
-    Logger.print_status(f"Remove '{instance.env_file}'")
-    if not instance.env_file.exists():
-        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
-        Logger.print_info(msg)
-        return
-    run_remove_routines(instance.env_file)

kiauh/components/moonraker/moonraker_setup.py

@@ -1,219 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import json
-import subprocess
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker import (
-    EXIT_MOONRAKER_SETUP,
-    MOONRAKER_DEPS_JSON_FILE,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
-    MOONRAKER_INSTALL_SCRIPT,
-    MOONRAKER_REQ_FILE,
-    MOONRAKER_SPEEDUPS_REQ_FILE,
-    POLKIT_FILE,
-    POLKIT_LEGACY_FILE,
-    POLKIT_SCRIPT,
-    POLKIT_USR_FILE,
-)
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.moonraker_dialogs import print_moonraker_overview
-from components.moonraker.moonraker_utils import (
-    backup_moonraker_dir,
-    create_example_moonraker_conf,
-)
-from components.webui_client.client_utils import (
-    enable_mainsail_remotemode,
-    get_existing_clients,
-)
-from components.webui_client.mainsail_data import MainsailData
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.fs_utils import check_file_exist
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import (
-    get_confirm,
-    get_selection_input,
-)
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    create_python_venv,
-    install_python_requirements,
-    parse_packages_from_file,
-)
-
-
-def install_moonraker() -> None:
-    klipper_list: List[Klipper] = get_instances(Klipper)
-
-    if not check_moonraker_install_requirements(klipper_list):
-        return
-
-    moonraker_list: List[Moonraker] = get_instances(Moonraker)
-    instances: List[Moonraker] = []
-    selected_option: str | Klipper
-
-    if len(klipper_list) == 1:
-        instances.append(Moonraker(klipper_list[0].suffix))
-    else:
-        print_moonraker_overview(
-            klipper_list,
-            moonraker_list,
-            show_index=True,
-            show_select_all=True,
-        )
-        options = {str(i + 1): k for i, k in enumerate(klipper_list)}
-        additional_options = {"a": None, "b": None}
-        options = {**options, **additional_options}
-        question = "Select Klipper instance to setup Moonraker for"
-        selected_option = get_selection_input(question, options)
-
-        if selected_option == "b":
-            Logger.print_status(EXIT_MOONRAKER_SETUP)
-            return
-
-        if selected_option == "a":
-            instances.extend([Moonraker(k.suffix) for k in klipper_list])
-        else:
-            klipper_instance: Klipper | None = options.get(selected_option)
-            if klipper_instance is None:
-                raise Exception("Error selecting instance!")
-            instances.append(Moonraker(klipper_instance.suffix))
-
-    create_example_cfg = get_confirm("Create example moonraker.conf?")
-
-    try:
-        check_install_dependencies()
-        setup_moonraker_prerequesites()
-        install_moonraker_polkit()
-
-        used_ports_map = {m.suffix: m.port for m in moonraker_list}
-        for instance in instances:
-            instance.create()
-            cmd_sysctl_service(instance.service_file_path.name, "enable")
-
-            if create_example_cfg:
-                # if a webclient and/or it's config is installed, patch
-                # its update section to the config
-                clients = get_existing_clients()
-                create_example_moonraker_conf(instance, used_ports_map, clients)
-
-            cmd_sysctl_service(instance.service_file_path.name, "start")
-
-        cmd_sysctl_manage("daemon-reload")
-
-        # if mainsail is installed, and we installed
-        # multiple moonraker instances, we enable mainsails remote mode
-        if MainsailData().client_dir.exists() and len(moonraker_list) > 1:
-            enable_mainsail_remotemode()
-
-    except Exception as e:
-        Logger.print_error(f"Error while installing Moonraker: {e}")
-        return
-
-
-def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
-    def check_klipper_instances() -> bool:
-        if len(klipper_list) >= 1:
-            return True
-
-        Logger.print_warn("Klipper not installed!")
-        Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
-        return False
-
-    return check_python_version(3, 7) and check_klipper_instances()
-
-
-def setup_moonraker_prerequesites() -> None:
-    settings = KiauhSettings()
-    repo = settings.moonraker.repo_url
-    branch = settings.moonraker.branch
-
-    git_clone_wrapper(repo, MOONRAKER_DIR, branch)
-
-    # install moonraker dependencies and create python virtualenv
-    install_moonraker_packages()
-    if create_python_venv(MOONRAKER_ENV_DIR):
-        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
-        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE)
-
-
-def install_moonraker_packages() -> None:
-    moonraker_deps = []
-
-    if MOONRAKER_DEPS_JSON_FILE.exists():
-        with open(MOONRAKER_DEPS_JSON_FILE, "r") as deps:
-            moonraker_deps = json.load(deps).get("debian", [])
-    elif MOONRAKER_INSTALL_SCRIPT.exists():
-        moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
-
-    if not moonraker_deps:
-        raise ValueError("Error reading Moonraker dependencies!")
-
-    check_install_dependencies({*moonraker_deps})
-
-
-def install_moonraker_polkit() -> None:
-    Logger.print_status("Installing Moonraker policykit rules ...")
-
-    legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
-    polkit_file_exists = check_file_exist(POLKIT_FILE, True)
-    usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
-
-    if legacy_file_exists or (polkit_file_exists and usr_file_exists):
-        Logger.print_info("Moonraker policykit rules are already installed.")
-        return
-
-    try:
-        command = [POLKIT_SCRIPT, "--disable-systemctl"]
-        result = subprocess.run(
-            command,
-            stderr=subprocess.PIPE,
-            stdout=subprocess.DEVNULL,
-            text=True,
-        )
-        if result.returncode != 0 or result.stderr:
-            Logger.print_error(f"{result.stderr}", False)
-            Logger.print_error("Installing Moonraker policykit rules failed!")
-            return
-
-        Logger.print_ok("Moonraker policykit rules successfully installed!")
-    except subprocess.CalledProcessError as e:
-        log = f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
-        Logger.print_error(log)
-
-
-def update_moonraker() -> None:
-    if not get_confirm("Update Moonraker now?"):
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_moonraker_dir()
-
-    instances = get_instances(Moonraker)
-    InstanceManager.stop_all(instances)
-
-    git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
-
-    # install possible new system packages
-    install_moonraker_packages()
-    # install possible new python dependencies
-    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
-
-    InstanceManager.start_all(instances)

kiauh/components/moonraker/services/moonraker_instance_service.py

@@ -0,0 +1,49 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from typing import Dict, List
+
+from components.moonraker.moonraker import Moonraker
+from utils.instance_utils import get_instances
+
+
+class MoonrakerInstanceService:
+    __cls_instance = None
+    __instances: List[Moonraker] = []
+
+    def __new__(cls) -> "MoonrakerInstanceService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(MoonrakerInstanceService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+
+    def load_instances(self) -> None:
+        self.__instances = get_instances(Moonraker)
+
+    def create_new_instance(self, suffix: str) -> Moonraker:
+        instance = Moonraker(suffix)
+        self.__instances.append(instance)
+        return instance
+
+    def get_all_instances(self) -> List[Moonraker]:
+        return self.__instances
+
+    def get_instance_by_suffix(self, suffix: str) -> Moonraker | None:
+        instances: List[Moonraker] = [i for i in self.__instances if i.suffix == suffix]
+        return instances[0] if instances else None
+
+    def get_instance_port_map(self) -> Dict[str, int]:
+        return {i.suffix: i.port for i in self.__instances}

kiauh/components/moonraker/services/moonraker_setup_service.py

@@ -0,0 +1,408 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from copy import copy
+from subprocess import DEVNULL, PIPE, CalledProcessError, run
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import print_instance_overview
+from components.klipper.services.klipper_instance_service import KlipperInstanceService
+from components.moonraker import (
+    EXIT_MOONRAKER_SETUP,
+    MOONRAKER_DIR,
+    MOONRAKER_ENV_DIR,
+    MOONRAKER_REPO_URL,
+    MOONRAKER_REQ_FILE,
+    MOONRAKER_SPEEDUPS_REQ_FILE,
+    POLKIT_FILE,
+    POLKIT_LEGACY_FILE,
+    POLKIT_SCRIPT,
+    POLKIT_USR_FILE,
+)
+from components.moonraker.moonraker import Moonraker
+from components.moonraker.moonraker_dialogs import print_moonraker_overview
+from components.moonraker.services.moonraker_instance_service import (
+    MoonrakerInstanceService,
+)
+from components.moonraker.utils.utils import (
+    backup_moonraker_dir,
+    create_example_moonraker_conf,
+    install_moonraker_packages,
+    remove_polkit_rules,
+)
+from components.webui_client.client_utils import (
+    enable_mainsail_remotemode,
+    get_existing_clients,
+)
+from components.webui_client.mainsail_data import MainsailData
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.services.message_service import Message, MessageService
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
+from utils.common import check_install_dependencies
+from utils.fs_utils import check_file_exist, run_remove_routines
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import (
+    get_confirm,
+    get_selection_input,
+)
+from utils.sys_utils import (
+    check_python_version,
+    cmd_sysctl_manage,
+    cmd_sysctl_service,
+    create_python_venv,
+    get_ipv4_addr,
+    install_python_requirements,
+    unit_file_exists,
+)
+
+
+# noinspection PyMethodMayBeStatic
+class MoonrakerSetupService:
+    __cls_instance = None
+
+    kisvc: KlipperInstanceService
+    misvc: MoonrakerInstanceService
+    msgsvc = MessageService
+
+    settings: KiauhSettings
+    klipper_list: List[Klipper]
+    moonraker_list: List[Moonraker]
+
+    def __new__(cls) -> "MoonrakerSetupService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(MoonrakerSetupService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+        self.__init_state()
+
+    def __init_state(self) -> None:
+        self.settings = KiauhSettings()
+
+        self.kisvc = KlipperInstanceService()
+        self.kisvc.load_instances()
+        self.klipper_list = self.kisvc.get_all_instances()
+
+        self.misvc = MoonrakerInstanceService()
+        self.misvc.load_instances()
+        self.moonraker_list = self.misvc.get_all_instances()
+
+        self.msgsvc = MessageService()
+
+    def __refresh_state(self) -> None:
+        self.kisvc.load_instances()
+        self.klipper_list = self.kisvc.get_all_instances()
+
+        self.misvc.load_instances()
+        self.moonraker_list = self.misvc.get_all_instances()
+
+    def install(self) -> None:
+        self.__refresh_state()
+
+        if not self.__check_requirements(self.klipper_list):
+            return
+
+        new_instances: List[Moonraker] = []
+        selected_option: str | Klipper
+
+        if len(self.klipper_list) == 1:
+            suffix: str = self.klipper_list[0].suffix
+            new_inst = self.misvc.create_new_instance(suffix)
+            new_instances.append(new_inst)
+
+        else:
+            print_moonraker_overview(
+                self.klipper_list,
+                self.moonraker_list,
+                show_index=True,
+                show_select_all=True,
+            )
+            options = {str(i + 1): k for i, k in enumerate(self.klipper_list)}
+            additional_options = {"a": None, "b": None}
+            options = {**options, **additional_options}
+            question = "Select Klipper instance to setup Moonraker for"
+            selected_option = get_selection_input(question, options)
+
+            if selected_option == "b":
+                Logger.print_status(EXIT_MOONRAKER_SETUP)
+                return
+
+            if selected_option == "a":
+                new_inst_list: List[Moonraker] = [
+                    self.misvc.create_new_instance(k.suffix) for k in self.klipper_list
+                ]
+                new_instances.extend(new_inst_list)
+            else:
+                klipper_instance: Klipper | None = options.get(selected_option)
+                if klipper_instance is None:
+                    raise Exception("Error selecting instance!")
+                new_inst = self.misvc.create_new_instance(klipper_instance.suffix)
+                new_instances.append(new_inst)
+
+        create_example_cfg = get_confirm("Create example moonraker.conf?")
+
+        try:
+            self.__run_setup(new_instances, create_example_cfg)
+        except Exception as e:
+            Logger.print_error(f"Error while installing Moonraker: {e}")
+            return
+
+    def update(self) -> None:
+        Logger.print_dialog(
+            DialogType.WARNING,
+            [
+                "Be careful if there are ongoing prints running!",
+                "All Moonraker instances will be restarted during the update process and "
+                "ongoing prints COULD FAIL.",
+            ],
+        )
+
+        if not get_confirm("Update Moonraker now?"):
+            return
+
+        self.__refresh_state()
+
+        if self.settings.kiauh.backup_before_update:
+            backup_moonraker_dir()
+
+        InstanceManager.stop_all(self.moonraker_list)
+        git_pull_wrapper(MOONRAKER_DIR)
+        install_moonraker_packages()
+        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
+        InstanceManager.start_all(self.moonraker_list)
+
+    def remove(
+        self,
+        remove_service: bool,
+        remove_dir: bool,
+        remove_env: bool,
+        remove_polkit: bool,
+    ) -> None:
+        self.__refresh_state()
+
+        completion_msg = Message(
+            title="Moonraker Removal Process completed",
+            color=Color.GREEN,
+        )
+
+        if remove_service:
+            Logger.print_status("Removing Moonraker instances ...")
+            if self.moonraker_list:
+                instances_to_remove = self.__get_instances_to_remove()
+                self.__remove_instances(instances_to_remove)
+                if instances_to_remove:
+                    instance_names = [
+                        i.service_file_path.stem for i in instances_to_remove
+                    ]
+                    txt = f"● Moonraker instances removed: {', '.join(instance_names)}"
+                    completion_msg.text.append(txt)
+            else:
+                Logger.print_info("No Moonraker Services installed! Skipped ...")
+
+        if (remove_polkit or remove_dir or remove_env) and unit_file_exists(
+            "moonraker", suffix="service"
+        ):
+            completion_msg.text = [
+                "Some Klipper services are still installed:",
+                "● Moonraker PolicyKit rules were not removed, even though selected for removal.",
+                f"● '{MOONRAKER_DIR}' was not removed, even though selected for removal.",
+                f"● '{MOONRAKER_ENV_DIR}' was not removed, even though selected for removal.",
+            ]
+        else:
+            if remove_polkit:
+                Logger.print_status("Removing all Moonraker policykit rules ...")
+                if remove_polkit_rules():
+                    completion_msg.text.append("● Moonraker policykit rules removed")
+            if remove_dir:
+                Logger.print_status("Removing Moonraker local repository ...")
+                if run_remove_routines(MOONRAKER_DIR):
+                    completion_msg.text.append("● Moonraker local repository removed")
+            if remove_env:
+                Logger.print_status("Removing Moonraker Python environment ...")
+                if run_remove_routines(MOONRAKER_ENV_DIR):
+                    completion_msg.text.append("● Moonraker Python environment removed")
+
+        if completion_msg.text:
+            completion_msg.text.insert(0, "The following actions were performed:")
+        else:
+            completion_msg.color = Color.YELLOW
+            completion_msg.centered = True
+            completion_msg.text = ["Nothing to remove."]
+
+        self.msgsvc.set_message(completion_msg)
+
+    def __run_setup(
+        self, new_instances: List[Moonraker], create_example_cfg: bool
+    ) -> None:
+        check_install_dependencies()
+        self.__install_deps()
+
+        ports_map = self.misvc.get_instance_port_map()
+        for i in new_instances:
+            i.create()
+            cmd_sysctl_service(i.service_file_path.name, "enable")
+
+            if create_example_cfg:
+                # if a webclient and/or it's config is installed, patch
+                # its update section to the config
+                clients = get_existing_clients()
+                create_example_moonraker_conf(i, ports_map, clients)
+
+            cmd_sysctl_service(i.service_file_path.name, "start")
+
+        cmd_sysctl_manage("daemon-reload")
+
+        # if mainsail is installed, and we installed
+        # multiple moonraker instances, we enable mainsails remote mode
+        if MainsailData().client_dir.exists() and len(self.moonraker_list) > 1:
+            enable_mainsail_remotemode()
+
+        self.misvc.load_instances()
+        new_instances = [
+            self.misvc.get_instance_by_suffix(i.suffix) for i in new_instances
+        ]
+
+        ip: str = get_ipv4_addr()
+        # noinspection HttpUrlsUsage
+        url_list = [
+            f"● {i.service_file_path.stem}: http://{ip}:{i.port}"
+            for i in new_instances
+            if i.port
+        ]
+        dialog_content = []
+        if url_list:
+            dialog_content.append("You can access Moonraker via the following URL:")
+            dialog_content.extend(url_list)
+
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            custom_title="Moonraker successfully installed!",
+            custom_color=Color.GREEN,
+            content=dialog_content,
+        )
+
+    def __check_requirements(self, klipper_list: List[Klipper]) -> bool:
+        is_klipper_installed = len(klipper_list) >= 1
+        if not is_klipper_installed:
+            Logger.print_warn("Klipper not installed!")
+            Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
+
+        is_python_ok = check_python_version(3, 7)
+
+        return is_klipper_installed and is_python_ok
+
+    def __install_deps(self) -> None:
+        default_repo = (MOONRAKER_REPO_URL, "master")
+        repo = self.settings.moonraker.repositories
+        # pull the first repo defined in kiauh.cfg or fallback to the official Moonraker repo
+        repo, branch = (repo[0].url, repo[0].branch) if repo else default_repo
+        git_clone_wrapper(repo, MOONRAKER_DIR, branch)
+
+        try:
+            install_moonraker_packages()
+            if create_python_venv(MOONRAKER_ENV_DIR, False, False, self.settings.moonraker.use_python_binary):
+                install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
+                if self.settings.moonraker.optional_speedups:
+                    install_python_requirements(
+                        MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE
+                    )
+            self.__install_polkit()
+        except Exception:
+            Logger.print_error("Error during installation of Moonraker requirements!")
+            raise
+
+    def __install_polkit(self) -> None:
+        Logger.print_status("Installing Moonraker policykit rules ...")
+
+        legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
+        polkit_file_exists = check_file_exist(POLKIT_FILE, True)
+        usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
+
+        if legacy_file_exists or (polkit_file_exists and usr_file_exists):
+            Logger.print_info("Moonraker policykit rules are already installed.")
+            return
+
+        try:
+            command = [POLKIT_SCRIPT, "--disable-systemctl"]
+            result = run(
+                command,
+                stderr=PIPE,
+                stdout=DEVNULL,
+                text=True,
+            )
+            if result.returncode != 0 or result.stderr:
+                Logger.print_error(f"{result.stderr}", False)
+                Logger.print_error("Installing Moonraker policykit rules failed!")
+                return
+
+            Logger.print_ok("Moonraker policykit rules successfully installed!")
+        except CalledProcessError as e:
+            log = (
+                f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
+            )
+            Logger.print_error(log)
+
+    def __get_instances_to_remove(self) -> List[Moonraker] | None:
+        start_index = 1
+        curr_instances: List[Moonraker] = self.moonraker_list
+        instance_count = len(curr_instances)
+
+        options = [str(i + start_index) for i in range(instance_count)]
+        options.extend(["a", "b"])
+        instance_map = {
+            options[i]: self.moonraker_list[i] for i in range(instance_count)
+        }
+
+        print_instance_overview(
+            self.moonraker_list,
+            start_index=start_index,
+            show_index=True,
+            show_select_all=True,
+        )
+        selection = get_selection_input("Select Moonraker instance to remove", options)
+
+        if selection == "b":
+            return None
+        elif selection == "a":
+            return copy(self.moonraker_list)
+
+        return [instance_map[selection]]
+
+    def __remove_instances(
+        self,
+        instance_list: List[Moonraker] | None,
+    ) -> None:
+        if not instance_list:
+            return
+
+        for instance in instance_list:
+            Logger.print_status(
+                f"Removing instance {instance.service_file_path.stem} ..."
+            )
+            InstanceManager.remove(instance)
+            self.__delete_env_file(instance)
+
+        self.__refresh_state()
+
+    def __delete_env_file(self, instance: Moonraker):
+        Logger.print_status(f"Remove '{instance.env_file}'")
+        if not instance.env_file.exists():
+            msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
+            Logger.print_info(msg)
+            return
+        run_remove_routines(instance.env_file)

kiauh/components/moonraker/utils/sysdeps_parser.py

@@ -0,0 +1,179 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#  It was modified by Dominik Willner <th33xitus@gmail.com>               #
+#                                                                         #
+#  The original file is part of Moonraker:                                #
+#  https://github.com/Arksine/moonraker                                   #
+#  Copyright (C) 2025 Eric Callahan <arksine.code@gmail.com>              #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import logging
+import pathlib
+import re
+import shlex
+from typing import Any, Dict, List, Tuple
+
+
+def _get_distro_info() -> Dict[str, Any]:
+    release_file = pathlib.Path("/etc/os-release")
+    release_info: Dict[str, str] = {}
+    with release_file.open("r") as f:
+        lexer = shlex.shlex(f, posix=True)
+        lexer.whitespace_split = True
+        for item in list(lexer):
+            if "=" in item:
+                key, val = item.split("=", maxsplit=1)
+                release_info[key] = val
+    return dict(
+        distro_id=release_info.get("ID", ""),
+        distro_version=release_info.get("VERSION_ID", ""),
+        aliases=release_info.get("ID_LIKE", "").split(),
+    )
+
+
+def _convert_version(version: str) -> Tuple[str | int, ...]:
+    version = version.strip()
+    ver_match = re.match(r"\d+(\.\d+)*((?:-|\.).+)?", version)
+    if ver_match is not None:
+        return tuple(
+            [
+                int(part) if part.isdigit() else part
+                for part in re.split(r"\.|-", version)
+            ]
+        )
+    return (version,)
+
+
+class SysDepsParser:
+    def __init__(self, distro_info: Dict[str, Any] | None = None) -> None:
+        if distro_info is None:
+            distro_info = _get_distro_info()
+        self.distro_id: str = distro_info.get("distro_id", "")
+        self.aliases: List[str] = distro_info.get("aliases", [])
+        self.distro_version: Tuple[int | str, ...] = tuple()
+        version = distro_info.get("distro_version")
+        if version:
+            self.distro_version = _convert_version(version)
+        self.vendor: str = ""
+        if pathlib.Path("/etc/rpi-issue").is_file():
+            self.vendor = "raspberry-pi"
+
+    def _parse_spec(self, full_spec: str) -> str | None:
+        parts = full_spec.split(";", maxsplit=1)
+        if len(parts) == 1:
+            return full_spec
+        pkg_name = parts[0].strip()
+        expressions = re.split(r"( and | or )", parts[1].strip())
+        if not len(expressions) & 1:
+            # There should always be an odd number of expressions.  Each
+            # expression is separated by an "and" or "or" operator
+            logging.info(
+                f"Requirement specifier is missing an expression "
+                f"between logical operators : {full_spec}"
+            )
+            return None
+        last_result: bool = True
+        last_logical_op: str | None = "and"
+        for idx, exp in enumerate(expressions):
+            if idx & 1:
+                if last_logical_op is not None:
+                    logging.info(
+                        "Requirement specifier contains sequential logical "
+                        f"operators: {full_spec}"
+                    )
+                    return None
+                logical_op = exp.strip()
+                if logical_op not in ("and", "or"):
+                    logging.info(
+                        f"Invalid logical operator {logical_op} in requirement "
+                        f"specifier: {full_spec}"
+                    )
+                    return None
+                last_logical_op = logical_op
+                continue
+            elif last_logical_op is None:
+                logging.info(
+                    f"Requirement specifier contains two seqential expressions "
+                    f"without a logical operator: {full_spec}"
+                )
+                return None
+            dep_parts = re.split(r"(==|!=|<=|>=|<|>)", exp.strip())
+            req_var = dep_parts[0].strip().lower()
+            if len(dep_parts) != 3:
+                logging.info(f"Invalid comparison, must be 3 parts: {full_spec}")
+                return None
+            elif req_var == "distro_id":
+                left_op: str | Tuple[int | str, ...] = self.distro_id
+                right_op = dep_parts[2].strip().strip("\"'")
+            elif req_var == "vendor":
+                left_op = self.vendor
+                right_op = dep_parts[2].strip().strip("\"'")
+            elif req_var == "distro_version":
+                if not self.distro_version:
+                    logging.info(
+                        "Distro Version not detected, cannot satisfy requirement: "
+                        f"{full_spec}"
+                    )
+                    return None
+                left_op = self.distro_version
+                right_op = _convert_version(dep_parts[2].strip().strip("\"'"))
+            else:
+                logging.info(f"Invalid requirement specifier: {full_spec}")
+                return None
+            operator = dep_parts[1].strip()
+            try:
+                compfunc = {
+                    "<": lambda x, y: x < y,
+                    ">": lambda x, y: x > y,
+                    "==": lambda x, y: x == y,
+                    "!=": lambda x, y: x != y,
+                    ">=": lambda x, y: x >= y,
+                    "<=": lambda x, y: x <= y,
+                }.get(operator, lambda x, y: False)
+                result = compfunc(left_op, right_op)
+                if last_logical_op == "and":
+                    last_result &= result
+                else:
+                    last_result |= result
+                last_logical_op = None
+            except Exception:
+                logging.exception(f"Error comparing requirements: {full_spec}")
+                return None
+        if last_result:
+            return pkg_name
+        return None
+
+    def parse_dependencies(self, sys_deps: Dict[str, List[str]]) -> List[str]:
+        if not self.distro_id:
+            logging.info(
+                "Failed to detect current distro ID, cannot parse dependencies"
+            )
+            return []
+        all_ids = [self.distro_id] + self.aliases
+        for distro_id in all_ids:
+            if distro_id in sys_deps:
+                if not sys_deps[distro_id]:
+                    logging.info(
+                        f"Dependency data contains an empty package definition "
+                        f"for linux distro '{distro_id}'"
+                    )
+                    continue
+                processed_deps: List[str] = []
+                for dep in sys_deps[distro_id]:
+                    parsed_dep = self._parse_spec(dep)
+                    if parsed_dep is not None:
+                        processed_deps.append(parsed_dep)
+                return processed_deps
+        else:
+            logging.info(
+                f"Dependency data has no package definition for linux "
+                f"distro '{self.distro_id}'"
+            )
+        return []

kiauh/components/moonraker/utils/utils.py

@@ -1,35 +1,39 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-
+import json
 import shutil
+from pathlib import Path
+from subprocess import DEVNULL, PIPE, CalledProcessError, run
 from typing import Dict, List, Optional
 
 from components.moonraker import (
     MODULE_PATH,
-    MOONRAKER_BACKUP_DIR,
-    MOONRAKER_DB_BACKUP_DIR,
     MOONRAKER_DEFAULT_PORT,
+    MOONRAKER_DEPS_JSON_FILE,
     MOONRAKER_DIR,
     MOONRAKER_ENV_DIR,
+    MOONRAKER_INSTALL_SCRIPT,
 )
 from components.moonraker.moonraker import Moonraker
+from components.moonraker.utils.sysdeps_parser import SysDepsParser
 from components.webui_client.base_data import BaseWebClient
-from core.backup_manager.backup_manager import BackupManager
 from core.logger import Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from core.types import ComponentStatus
-from utils.common import get_install_status
+from core.types.component_status import ComponentStatus
+from utils.common import check_install_dependencies, get_install_status
 from utils.instance_utils import get_instances
 from utils.sys_utils import (
     get_ipv4_addr,
+    parse_packages_from_file,
 )
 
 
@@ -37,6 +41,46 @@ def get_moonraker_status() -> ComponentStatus:
     return get_install_status(MOONRAKER_DIR, MOONRAKER_ENV_DIR, Moonraker)
 
 
+def install_moonraker_packages() -> None:
+    Logger.print_status("Parsing Moonraker system dependencies  ...")
+
+    moonraker_deps = []
+    if MOONRAKER_DEPS_JSON_FILE.exists():
+        Logger.print_info(
+            f"Parsing system dependencies from {MOONRAKER_DEPS_JSON_FILE.name} ..."
+        )
+        parser = SysDepsParser()
+        sysdeps = load_sysdeps_json(MOONRAKER_DEPS_JSON_FILE)
+        moonraker_deps.extend(parser.parse_dependencies(sysdeps))
+
+    elif MOONRAKER_INSTALL_SCRIPT.exists():
+        Logger.print_warn(f"{MOONRAKER_DEPS_JSON_FILE.name} not found!")
+        Logger.print_info(
+            f"Parsing system dependencies from {MOONRAKER_INSTALL_SCRIPT.name} ..."
+        )
+        moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
+
+    if not moonraker_deps:
+        raise ValueError("Error parsing Moonraker dependencies!")
+
+    check_install_dependencies({*moonraker_deps})
+
+
+def remove_polkit_rules() -> bool:
+    if not MOONRAKER_DIR.exists():
+        log = "Cannot remove policykit rules. Moonraker directory not found."
+        Logger.print_warn(log)
+        return False
+
+    try:
+        cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
+        run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
+        return True
+    except CalledProcessError as e:
+        Logger.print_error(f"Error while removing policykit rules: {e}")
+        return False
+
+
 def create_example_moonraker_conf(
     instance: Moonraker,
     ports_map: Dict[str, int],
@@ -79,8 +123,8 @@ def create_example_moonraker_conf(
     scp = SimpleConfigParser()
     scp.read_file(target)
     trusted_clients: List[str] = [
-        f"    {'.'.join(ip)}\n",
-        *scp.getval("authorization", "trusted_clients"),
+        f"{'.'.join(ip)}",
+        *scp.getvals("authorization", "trusted_clients"),
     ]
 
     scp.set_option("server", "port", str(port))
@@ -122,19 +166,63 @@ def create_example_moonraker_conf(
 
 
 def backup_moonraker_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
-    bm.backup_directory(
-        "moonraker-env", source=MOONRAKER_ENV_DIR, target=MOONRAKER_BACKUP_DIR
+    svc = BackupService()
+    svc.backup_directory(
+        source_path=MOONRAKER_DIR, backup_name="moonraker", target_path="moonraker"
+    )
+    svc.backup_directory(
+        source_path=MOONRAKER_ENV_DIR,
+        backup_name="moonraker-env",
+        target_path="moonraker",
     )
 
 
 def backup_moonraker_db_dir() -> None:
     instances: List[Moonraker] = get_instances(Moonraker)
-    bm = BackupManager()
+    svc = BackupService()
+
+    if not instances:
+        # fallback: search for printer data directories in the user's home directory
+        Logger.print_info("No Moonraker instances found via systemd services.")
+        Logger.print_info(
+            "Attempting to find printer data directories in home directory..."
+        )
+
+        home_dir = Path.home()
+        printer_data_dirs = []
+
+        for pattern in ["printer_data", "printer_*_data"]:
+            for data_dir in home_dir.glob(pattern):
+                if data_dir.is_dir():
+                    printer_data_dirs.append(data_dir)
+
+        if not printer_data_dirs:
+            Logger.print_info("Unable to find directory to backup!")
+            Logger.print_info("No printer data directories found in home directory.")
+            return
+
+        for data_dir in printer_data_dirs:
+            svc.backup_directory(
+                source_path=data_dir.joinpath("database"),
+                target_path=data_dir.name,
+                backup_name="database",
+            )
+
+        return
 
     for instance in instances:
-        name = f"database-{instance.data_dir.name}"
-        bm.backup_directory(
-            name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
+        svc.backup_directory(
+            source_path=instance.db_dir,
+            target_path=f"{instance.data_dir.name}",
+            backup_name="database",
         )
+
+
+def load_sysdeps_json(file: Path) -> Dict[str, List[str]]:
+    try:
+        sysdeps: Dict[str, List[str]] = json.loads(file.read_bytes())
+    except json.JSONDecodeError as e:
+        Logger.print_error(f"Unable to parse {file.name}:\n{e}")
+        return {}
+    else:
+        return sysdeps

kiauh/components/webui_client/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/components/webui_client/base_data.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -34,9 +34,9 @@ class BaseWebClient(ABC):
     display_name: str
     client_dir: Path
     config_file: Path
-    backup_dir: Path
     repo_path: str
     download_url: str
+    nginx_config: Path
     nginx_access_log: Path
     nginx_error_log: Path
     client_config: BaseWebClientConfig
@@ -51,6 +51,5 @@ class BaseWebClientConfig(ABC):
     display_name: str
     config_filename: str
     config_dir: Path
-    backup_dir: Path
     repo_url: str
     config_section: str

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -14,8 +14,12 @@ from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClientConfig
 from core.logger import Logger
+from core.services.backup_service import BackupService
+from core.services.message_service import Message
+from core.types.color import Color
 from utils.config_utils import remove_config_section
 from utils.fs_utils import run_remove_routines
+from utils.instance_type import InstanceType
 from utils.instance_utils import get_instances
 
 
@@ -23,21 +27,68 @@ def run_client_config_removal(
     client_config: BaseWebClientConfig,
     kl_instances: List[Klipper],
     mr_instances: List[Moonraker],
-) -> None:
-    remove_client_config_dir(client_config)
-    remove_client_config_symlink(client_config)
-    remove_config_section(f"update_manager {client_config.name}", mr_instances)
-    remove_config_section(client_config.config_section, kl_instances)
-
-
-def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
-    Logger.print_status(f"Removing {client_config.display_name} ...")
-    run_remove_routines(client_config.config_dir)
-
-
-def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
-    instances: List[Klipper] = get_instances(Klipper)
-    for instance in instances:
-        run_remove_routines(
-            instance.base.cfg_dir.joinpath(client_config.config_filename)
+) -> Message:
+    completion_msg = Message(
+        title=f"{client_config.display_name} Removal Process completed",
+        color=Color.GREEN,
     )
+    Logger.print_status(f"Removing {client_config.display_name} ...")
+    if run_remove_routines(client_config.config_dir):
+        completion_msg.text.append(f"● {client_config.display_name} removed")
+
+    BackupService().backup_printer_config_dir()
+
+    completion_msg = remove_moonraker_config_section(
+        completion_msg, client_config, mr_instances
+    )
+
+    completion_msg = remove_printer_config_section(
+        completion_msg, client_config, kl_instances
+    )
+
+    if completion_msg.text:
+        completion_msg.text.insert(0, "The following actions were performed:")
+    else:
+        completion_msg.color = Color.YELLOW
+        completion_msg.centered = True
+        completion_msg.text = ["Nothing to remove."]
+
+    return completion_msg
+
+
+def remove_cfg_symlink(client_config: BaseWebClientConfig, message: Message) -> Message:
+    instances: List[Klipper] = get_instances(Klipper)
+    kl_instances = []
+    for instance in instances:
+        cfg = instance.base.cfg_dir.joinpath(client_config.config_filename)
+        if run_remove_routines(cfg):
+            kl_instances.append(instance)
+    text = f"{client_config.display_name} removed from instance"
+    return update_msg(kl_instances, message, text)
+
+
+def remove_printer_config_section(
+    message: Message, client_config: BaseWebClientConfig, kl_instances: List[Klipper]
+) -> Message:
+    kl_section = client_config.config_section
+    kl_instances = remove_config_section(kl_section, kl_instances)
+    text = f"Klipper config section '{kl_section}' removed for instance"
+    return update_msg(kl_instances, message, text)
+
+
+def remove_moonraker_config_section(
+    message: Message, client_config: BaseWebClientConfig, mr_instances: List[Moonraker]
+) -> Message:
+    mr_section = f"update_manager {client_config.name}"
+    mr_instances = remove_config_section(mr_section, mr_instances)
+    text = f"Moonraker config section '{mr_section}' removed for instance"
+    return update_msg(mr_instances, message, text)
+
+
+def update_msg(instances: List[InstanceType], message: Message, text: str) -> Message:
+    if not instances:
+        return message
+
+    instance_names = [i.service_file_path.stem for i in instances]
+    message.text.append(f"● {text}: {', '.join(instance_names)}")
+    return message

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -25,8 +25,8 @@ from components.webui_client.client_utils import (
 )
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
-from utils.common import backup_printer_config_dir
 from utils.config_utils import add_config_section, add_config_section_at_top
 from utils.fs_utils import create_symlink
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
@@ -34,7 +34,7 @@ from utils.input_utils import get_confirm
 from utils.instance_utils import get_instances
 
 
-def install_client_config(client_data: BaseWebClient) -> None:
+def install_client_config(client_data: BaseWebClient, cfg_backup=True) -> None:
     client_config: BaseWebClientConfig = client_data.client_config
     display_name = client_config.display_name
 
@@ -56,7 +56,8 @@ def install_client_config(client_data: BaseWebClient) -> None:
         download_client_config(client_config)
         create_client_config_symlink(client_config, kl_instances)
 
-        backup_printer_config_dir()
+        if cfg_backup:
+            BackupService().backup_printer_config_dir()
 
         add_config_section(
             section=f"update_manager {client_config.name}",
@@ -105,7 +106,7 @@ def update_client_config(client: BaseWebClient) -> None:
     if settings.kiauh.backup_before_update:
         backup_client_config_data(client)
 
-    git_pull_wrapper(client_config.repo_url, client_config.config_dir)
+    git_pull_wrapper(client_config.config_dir)
 
     Logger.print_ok(f"Successfully updated {client_config.display_name}.")
     Logger.print_info("Restart Klipper to reload the configuration!")

kiauh/components/webui_client/client_dialogs.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -13,15 +13,15 @@ from components.webui_client.base_data import BaseWebClient
 from core.logger import DialogType, Logger
 
 
-def print_moonraker_not_found_dialog() -> None:
+def print_moonraker_not_found_dialog(name: str) -> None:
     Logger.print_dialog(
         DialogType.WARNING,
         [
             "No local Moonraker installation was found!",
             "\n\n",
-            "It is possible to install Mainsail without a local Moonraker installation. "
+            f"It is possible to install {name} without a local Moonraker installation. "
             "If you continue, you need to make sure, that Moonraker is installed on "
-            "another machine in your network. Otherwise Mainsail will NOT work "
+            f"another machine in your network. Otherwise {name} will NOT work "
             "correctly.",
         ],
     )
@@ -40,21 +40,26 @@ def print_client_already_installed_dialog(name: str) -> None:
 def print_client_port_select_dialog(
     name: str, port: int, ports_in_use: List[int]
 ) -> None:
-    Logger.print_dialog(
-        DialogType.CUSTOM,
-        [
+    dialog_content: List[str] = [
         f"Please select the port, {name} should be served on. If your are unsure "
         f"what to select, hit Enter to apply the suggested value of: {port}",
         "\n\n",
         f"In case you need {name} to be served on a specific port, you can set it "
         f"now. Make sure that the port is not already used by another application "
         f"on your system!",
+    ]
+
+    if ports_in_use:
+        dialog_content.extend(
+            [
                 "\n\n",
-            "The following ports were found to be in use already:",
-            *[f"● {port}" for port in ports_in_use],
-        ],
+                "The following ports were found to be already in use:",
+                *[f"● {p}" for p in ports_in_use if p != port],
+            ]
         )
 
+    Logger.print_dialog(DialogType.CUSTOM, dialog_content)
+
 
 def print_install_client_config_dialog(client: BaseWebClient) -> None:
     name = client.display_name

kiauh/components/webui_client/client_remove.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -16,9 +16,11 @@ from components.webui_client.base_data import (
 from components.webui_client.client_config.client_config_remove import (
     run_client_config_removal,
 )
-from core.backup_manager.backup_manager import BackupManager
 from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
 from core.logger import Logger
+from core.services.backup_service import BackupService
+from core.services.message_service import Message
+from core.types.color import Color
 from utils.config_utils import remove_config_section
 from utils.fs_utils import (
     remove_with_sudo,
@@ -32,54 +34,91 @@ def run_client_removal(
     remove_client: bool,
     remove_client_cfg: bool,
     backup_config: bool,
-) -> None:
+) -> Message:
+    completion_msg = Message(
+        title=f"{client.display_name} Removal Process completed",
+        color=Color.GREEN,
+    )
     mr_instances: List[Moonraker] = get_instances(Moonraker)
     kl_instances: List[Klipper] = get_instances(Klipper)
 
     if backup_config:
-        bm = BackupManager()
-        bm.backup_file(client.config_file)
+        version = ""
+        src = client.client_dir
+        if src.joinpath(".version").exists():
+            with open(src.joinpath(".version"), "r") as v:
+                version = v.readlines()[0]
+
+        svc = BackupService()
+        target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
+        success = svc.backup_file(
+            source_path=client.config_file,
+            target_path=target_path,
+        )
+        if success:
+            completion_msg.text.append(f"● {client.config_file.name} backup created")
 
     if remove_client:
         client_name = client.name
-        remove_client_dir(client)
-        remove_client_nginx_config(client_name)
-        remove_client_nginx_logs(client, kl_instances)
+        if remove_client_dir(client):
+            completion_msg.text.append(f"● {client.display_name} removed")
+        if remove_client_nginx_config(client_name):
+            completion_msg.text.append("● NGINX config removed")
+        if remove_client_nginx_logs(client, kl_instances):
+            completion_msg.text.append("● NGINX logs removed")
 
+        BackupService().backup_moonraker_conf()
         section = f"update_manager {client_name}"
-        remove_config_section(section, mr_instances)
+        handled_instances: List[Moonraker] = remove_config_section(
+            section, mr_instances
+        )
+        if handled_instances:
+            names = [i.service_file_path.stem for i in handled_instances]
+            completion_msg.text.append(
+                f"● Moonraker config section '{section}' removed for instance: {', '.join(names)}"
+            )
 
     if remove_client_cfg:
-        run_client_config_removal(
+        cfg_completion_msg = run_client_config_removal(
             client.client_config,
             kl_instances,
             mr_instances,
         )
+        if cfg_completion_msg.color == Color.GREEN:
+            completion_msg.text.extend(cfg_completion_msg.text[1:])
+
+    if not completion_msg.text:
+        completion_msg.color = Color.YELLOW
+        completion_msg.centered = True
+        completion_msg.text.append("Nothing to remove.")
+    else:
+        completion_msg.text.insert(0, "The following actions were performed:")
+
+    return completion_msg
 
 
-def remove_client_dir(client: BaseWebClient) -> None:
+def remove_client_dir(client: BaseWebClient) -> bool:
     Logger.print_status(f"Removing {client.display_name} ...")
-    run_remove_routines(client.client_dir)
+    return run_remove_routines(client.client_dir)
 
 
-def remove_client_nginx_config(name: str) -> None:
+def remove_client_nginx_config(name: str) -> bool:
     Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
-
-    remove_with_sudo(NGINX_SITES_AVAILABLE.joinpath(name))
-    remove_with_sudo(NGINX_SITES_ENABLED.joinpath(name))
+    return remove_with_sudo(
+        [
+            NGINX_SITES_AVAILABLE.joinpath(name),
+            NGINX_SITES_ENABLED.joinpath(name),
+        ]
+    )
 
 
-def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> None:
+def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> bool:
     Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
 
-    remove_with_sudo(client.nginx_access_log)
-    remove_with_sudo(client.nginx_error_log)
-
-    if not instances:
-        return
-
+    files = [client.nginx_access_log, client.nginx_error_log]
+    if instances:
         for instance in instances:
-        run_remove_routines(
-            instance.base.log_dir.joinpath(client.nginx_access_log.name)
-        )
-        run_remove_routines(instance.base.log_dir.joinpath(client.nginx_error_log.name))
+            files.append(instance.base.log_dir.joinpath(client.nginx_access_log.name))
+            files.append(instance.base.log_dir.joinpath(client.nginx_error_log.name))
+
+    return remove_with_sudo(files)

kiauh/components/webui_client/client_setup.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -23,7 +23,6 @@ from components.webui_client.client_config.client_config_setup import (
     install_client_config,
 )
 from components.webui_client.client_dialogs import (
-    print_client_port_select_dialog,
     print_install_client_config_dialog,
     print_moonraker_not_found_dialog,
 )
@@ -33,18 +32,18 @@ from components.webui_client.client_utils import (
     create_nginx_cfg,
     detect_client_cfg_conflict,
     enable_mainsail_remotemode,
-    get_next_free_port,
-    is_valid_port,
-    read_ports_from_nginx_configs,
+    get_client_port_selection,
     symlink_webui_nginx_log,
 )
 from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
+from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
 from utils.common import check_install_dependencies
 from utils.config_utils import add_config_section
 from utils.fs_utils import unzip
-from utils.input_utils import get_confirm, get_number_input
+from utils.input_utils import get_confirm
 from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_service,
@@ -53,21 +52,16 @@ from utils.sys_utils import (
 )
 
 
-def install_client(client: BaseWebClient) -> None:
-    if client is None:
-        raise ValueError("Missing parameter client_data!")
-
-    if client.client_dir.exists():
-        Logger.print_info(
-            f"{client.display_name} seems to be already installed! Skipped ..."
-        )
-        return
-
+def install_client(
+    client: BaseWebClient,
+    settings: KiauhSettings,
+    reinstall: bool = False,
+) -> None:
     mr_instances: List[Moonraker] = get_instances(Moonraker)
 
     enable_remotemode = False
     if not mr_instances:
-        print_moonraker_not_found_dialog()
+        print_moonraker_not_found_dialog(client.display_name)
         if not get_confirm(f"Continue {client.display_name} installation?"):
             return
 
@@ -92,21 +86,10 @@ def install_client(client: BaseWebClient) -> None:
         question = f"Download the recommended {client_config.display_name}?"
         install_client_cfg = get_confirm(question, allow_go_back=False)
 
-    settings = KiauhSettings()
-    port: int = settings.get(client.name, "port")
-    ports_in_use: List[int] = read_ports_from_nginx_configs()
-
-    # check if configured port is a valid number and not in use already
-    valid_port = is_valid_port(port, ports_in_use)
-    while not valid_port:
-        next_port = get_next_free_port(ports_in_use)
-        print_client_port_select_dialog(client.display_name, next_port, ports_in_use)
-        port = get_number_input(
-            f"Configure {client.display_name} for port",
-            min_count=int(next_port),
-            default=next_port,
+    default_port: int = int(settings.get(client.name, "port"))
+    port: int = (
+        default_port if reinstall else get_client_port_selection(client, settings)
     )
-        valid_port = is_valid_port(port, ports_in_use)
 
     check_install_dependencies({"nginx"})
 
@@ -114,11 +97,13 @@ def install_client(client: BaseWebClient) -> None:
         download_client(client)
         if enable_remotemode and client.client == WebClientType.MAINSAIL:
             enable_mainsail_remotemode()
-        if mr_instances:
+
+        BackupService().backup_printer_config_dir()
         add_config_section(
             section=f"update_manager {client.name}",
             instances=mr_instances,
             options=[
+                ("persistent_files", ["config.json"]),
                 ("type", "web"),
                 ("channel", "stable"),
                 ("repo", str(client.repo_path)),
@@ -126,8 +111,9 @@ def install_client(client: BaseWebClient) -> None:
             ],
         )
         InstanceManager.restart_all(mr_instances)
+
         if install_client_cfg and kl_instances:
-            install_client_config(client)
+            install_client_config(client, False)
 
         copy_upstream_nginx_cfg()
         copy_common_vars_nginx_cfg()
@@ -145,12 +131,24 @@ def install_client(client: BaseWebClient) -> None:
         cmd_sysctl_service("nginx", "restart")
 
     except Exception as e:
-        Logger.print_error(f"{client.display_name} installation failed!\n{e}")
+        Logger.print_error(e)
+        Logger.print_dialog(
+            DialogType.ERROR,
+            center_content=True,
+            content=[f"{client.display_name} installation failed!"],
+        )
         return
 
-    log = f"Open {client.display_name} now on: http://{get_ipv4_addr()}:{port}"
-    Logger.print_ok(f"{client.display_name} installation complete!", start="\n")
-    Logger.print_ok(log, prefix=False, end="\n\n")
+    # noinspection HttpUrlsUsage
+    Logger.print_dialog(
+        DialogType.CUSTOM,
+        custom_title=f"{client.display_name} installation complete!",
+        custom_color=Color.GREEN,
+        center_content=True,
+        content=[
+            f"Open {client.display_name} now on: http://{get_ipv4_addr()}{'' if port == 80 else f':{port}'}",
+        ],
+    )
 
 
 def download_client(client: BaseWebClient) -> None:

kiauh/components/webui_client/client_utils.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -11,6 +11,7 @@ from __future__ import annotations
 import json
 import re
 import shutil
+from json import JSONDecodeError
 from pathlib import Path
 from subprocess import PIPE, CalledProcessError, run
 from typing import List, get_args
@@ -21,29 +22,29 @@ from components.webui_client.base_data import (
     BaseWebClient,
     WebClientType,
 )
+from components.webui_client.client_dialogs import print_client_port_select_dialog
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.backup_manager.backup_manager import BackupManager
 from core.constants import (
-    COLOR_CYAN,
-    COLOR_YELLOW,
     NGINX_CONFD,
     NGINX_SITES_AVAILABLE,
     NGINX_SITES_ENABLED,
-    RESET_FORMAT,
 )
 from core.logger import Logger
-from core.settings.kiauh_settings import KiauhSettings
+from core.services.backup_service import BackupService
+from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from core.types import ComponentStatus
+from core.types.color import Color
+from core.types.component_status import ComponentStatus
 from utils.common import get_install_status
 from utils.fs_utils import create_symlink, remove_file
 from utils.git_utils import (
     get_latest_remote_tag,
     get_latest_unstable_tag,
 )
+from utils.input_utils import get_number_input
 from utils.instance_utils import get_instances
 
 
@@ -77,10 +78,10 @@ def get_current_client_config() -> str:
     installed = [c for c in clients if c.client_config.config_dir.exists()]
 
     if not installed:
-        return f"{COLOR_CYAN}-{RESET_FORMAT}"
+        return Color.apply("-", Color.CYAN)
     elif len(installed) == 1:
         cfg = installed[0].client_config
-        return f"{COLOR_CYAN}{cfg.display_name}{RESET_FORMAT}"
+        return Color.apply(cfg.display_name, Color.CYAN)
 
     # at this point, both client config folders exists, so we need to check
     # which are actually included in the printer.cfg of all klipper instances
@@ -99,18 +100,18 @@ def get_current_client_config() -> str:
 
         # if both are included in the same file, we have a potential conflict
         if includes_mainsail and includes_fluidd:
-            return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
+            return Color.apply("Conflict", Color.YELLOW)
 
     if not mainsail_includes and not fluidd_includes:
         # there are no includes at all, even though the client config folders exist
-        return f"{COLOR_CYAN}-{RESET_FORMAT}"
+        return Color.apply("-", Color.CYAN)
     elif len(fluidd_includes) > len(mainsail_includes):
         # there are more instances that include fluidd than mainsail
-        return f"{COLOR_CYAN}{fluidd.client_config.display_name}{RESET_FORMAT}"
+        return Color.apply(fluidd.client_config.display_name, Color.CYAN)
     else:
         # there are the same amount of non-conflicting includes for each config
         # or more instances include mainsail than fluidd
-        return f"{COLOR_CYAN}{mainsail.client_config.display_name}{RESET_FORMAT}"
+        return Color.apply(mainsail.client_config.display_name, Color.CYAN)
 
 
 def enable_mainsail_remotemode() -> None:
@@ -119,7 +120,7 @@ def enable_mainsail_remotemode() -> None:
     with open(c_json, "r") as f:
         config_data = json.load(f)
 
-    if config_data["instancesDB"] == "browser":
+    if config_data["instancesDB"] == "browser" or config_data["instancesDB"] == "json":
         Logger.print_info("Remote mode already configured. Skipped ...")
         return
 
@@ -151,18 +152,36 @@ def symlink_webui_nginx_log(
 def get_local_client_version(client: BaseWebClient) -> str | None:
     relinfo_file = client.client_dir.joinpath("release_info.json")
     version_file = client.client_dir.joinpath(".version")
+    default = "n/a"
 
     if not client.client_dir.exists():
-        return None
-    if not relinfo_file.is_file() and not version_file.is_file():
-        return "n/a"
+        return default
 
+    # try to get version from release_info.json first
     if relinfo_file.is_file():
-        with open(relinfo_file, "r") as f:
-            return str(json.load(f)["version"])
-    else:
+        try:
+            if relinfo_file.stat().st_size == 0:
+                raise JSONDecodeError("Empty file", "", 0)
+            with open(relinfo_file, "r", encoding="utf-8") as f:
+                data = json.load(f)
+            raw_version = data.get("version")
+            if raw_version is not None:
+                parsed = str(raw_version).strip()
+                if parsed:
+                    return parsed
+        except (JSONDecodeError, OSError):
+            Logger.print_error("Invalid 'release_info.json'")
+
+    # fallback to .version file
+    if version_file.is_file():
+        try:
             with open(version_file, "r") as f:
-            return f.readlines()[0]
+                line = f.readline().strip()
+            return line or default
+        except OSError:
+            Logger.print_error("Unable to read '.version'")
+
+    return default
 
 
 def get_remote_client_version(client: BaseWebClient) -> str | None:
@@ -175,26 +194,39 @@ def get_remote_client_version(client: BaseWebClient) -> str | None:
 
 
 def backup_client_data(client: BaseWebClient) -> None:
-    name = client.name
+    version = ""
     src = client.client_dir
-    dest = client.backup_dir
-
+    if src.joinpath(".version").exists():
         with open(src.joinpath(".version"), "r") as v:
             version = v.readlines()[0]
 
-    bm = BackupManager()
-    bm.backup_directory(f"{name}-{version}", src, dest)
-    bm.backup_file(client.config_file, dest)
-    bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
+    svc = BackupService()
+    target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
+    svc.backup_directory(
+        source_path=client.client_dir,
+        target_path=target_path,
+        backup_name=client.name,
+    )
+    svc.backup_file(
+        source_path=client.config_file,
+        target_path=target_path,
+    )
 
 
 def backup_client_config_data(client: BaseWebClient) -> None:
-    client_config = client.client_config
-    name = client_config.name
-    source = client_config.config_dir
-    target = client_config.backup_dir
-    bm = BackupManager()
-    bm.backup_directory(name, source, target)
+    version = ""
+    src = client.client_dir
+    if src.joinpath(".version").exists():
+        with open(src.joinpath(".version"), "r") as v:
+            version = v.readlines()[0]
+
+    svc = BackupService()
+    target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
+    svc.backup_directory(
+        source_path=client.client_config.config_dir,
+        target_path=target_path,
+        backup_name=client.client_config.name,
+    )
 
 
 def get_existing_clients() -> List[BaseWebClient]:
@@ -336,34 +368,94 @@ def create_nginx_cfg(
         raise
 
 
+def get_nginx_config_list() -> List[Path]:
+    """
+    Get a list of all NGINX config files in /etc/nginx/sites-enabled
+    :return: List of NGINX config files
+    """
+    configs: List[Path] = []
+    for config in NGINX_SITES_ENABLED.iterdir():
+        if not config.is_file():
+            continue
+        configs.append(config)
+    return configs
+
+
+def get_nginx_listen_port(config: Path) -> int | None:
+    """
+    Get the listen port from an NGINX config file
+    :param config: The NGINX config file to read the port from
+    :return: The listen port as int or None if not found/parsable
+    """
+
+    # noinspection HttpUrlsUsage
+    pattern = r"default_server|http://|https://|[;\[\]]"
+    port = ""
+    with open(config, "r") as cfg:
+        for line in cfg.readlines():
+            line = re.sub(pattern, "", line.strip())
+            if line.startswith("listen"):
+                if ":" not in line:
+                    port = line.split()[-1]
+                else:
+                    port = line.split(":")[-1]
+        try:
+            return int(port)
+        except ValueError:
+            Logger.print_error(
+                f"Unable to parse listen port {port} from {config.name}!"
+            )
+            return None
+
+
 def read_ports_from_nginx_configs() -> List[int]:
     """
-    Helper function to iterate over all NGINX configs and read all ports defined for listen
+    Helper function to iterate over all NGINX configs
+    and read all ports defined for listen
     :return: A sorted list of listen ports
     """
     if not NGINX_SITES_ENABLED.exists():
         return []
 
-    port_list = []
-    for config in NGINX_SITES_ENABLED.iterdir():
-        if not config.is_file():
-            continue
+    port_list: List[int] = []
+    for config in get_nginx_config_list():
+        port = get_nginx_listen_port(config)
+        if port is not None:
+            port_list.append(port)
 
-        with open(config, "r") as cfg:
-            lines = cfg.readlines()
-
-        for line in lines:
-            line = line.replace("default_server", "")
-            line = re.sub(r"[;:\[\]]", "", line.strip())
-            if line.startswith("listen") and line.split()[-1] not in port_list:
-                port_list.append(line.split()[-1])
-
-    ports_to_ints_list = [int(port) for port in port_list]
-    return sorted(ports_to_ints_list, key=lambda x: int(x))
+    return sorted(port_list, key=lambda x: int(x))
 
 
-def is_valid_port(port: int, ports_in_use: List[int]) -> bool:
-    return port not in ports_in_use
+def get_client_port_selection(
+    client: BaseWebClient,
+    settings: KiauhSettings,
+    reconfigure=False,
+) -> int:
+    default_port: int = int(settings.get(client.name, "port"))
+    ports_in_use: List[int] = read_ports_from_nginx_configs()
+    next_free_port: int = get_next_free_port(ports_in_use)
+
+    port: int = (
+        next_free_port
+        if not reconfigure and default_port in ports_in_use
+        else default_port
+    )
+
+    print_client_port_select_dialog(client.display_name, port, ports_in_use)
+
+    while True:
+        _type = "Reconfigure" if reconfigure else "Configure"
+        question = f"{_type} {client.display_name} for port"
+        port_input = get_number_input(question, min_value=80, default=port)
+
+        if port_input not in ports_in_use:
+            client_settings: WebUiSettings = settings[client.name]
+            client_settings.port = port_input
+            settings.save()
+
+            return port_input
+
+        Logger.print_error("This port is already in use. Please select another one.")
 
 
 def get_next_free_port(ports_in_use: List[int]) -> int:
@@ -371,3 +463,23 @@ def get_next_free_port(ports_in_use: List[int]) -> int:
     used_ports = set(map(int, ports_in_use))
 
     return min(valid_ports - used_ports)
+
+
+def set_listen_port(client: BaseWebClient, curr_port: int, new_port: int) -> None:
+    """
+    Set the port the client should listen on in the NGINX config
+    :param curr_port: The current port the client listens on
+    :param new_port: The new port to set
+    :param client: The client to set the port for
+    :return: None
+    """
+    config = NGINX_SITES_AVAILABLE.joinpath(client.name)
+    with open(config, "r") as f:
+        lines = f.readlines()
+
+    for i, line in enumerate(lines):
+        if "listen" in line:
+            lines[i] = line.replace(str(curr_port), str(new_port))
+
+    with open(config, "w") as f:
+        f.writelines(lines)

kiauh/components/webui_client/fluidd_data.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -18,7 +18,7 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
-from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import NGINX_SITES_AVAILABLE
 
 
 @dataclass()
@@ -29,7 +29,6 @@ class FluiddConfigWeb(BaseWebClientConfig):
     config_dir: Path = Path.home().joinpath("fluidd-config")
     config_filename: str = "fluidd.cfg"
     config_section: str = f"include {config_filename}"
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
     repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
 
 
@@ -42,8 +41,8 @@ class FluiddData(BaseWebClient):
     display_name: str = name.capitalize()
     client_dir: Path = Path.home().joinpath("fluidd")
     config_file: Path = client_dir.joinpath("config.json")
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
     repo_path: str = "fluidd-core/fluidd"
+    nginx_config: Path = NGINX_SITES_AVAILABLE.joinpath("fluidd")
     nginx_access_log: Path = Path("/var/log/nginx/fluidd-access.log")
     nginx_error_log: Path = Path("/var/log/nginx/fluidd-error.log")
     client_config: BaseWebClientConfig = None

kiauh/components/webui_client/mainsail_data.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -18,7 +18,7 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
-from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import NGINX_SITES_AVAILABLE
 
 
 @dataclass()
@@ -29,7 +29,6 @@ class MainsailConfigWeb(BaseWebClientConfig):
     config_dir: Path = Path.home().joinpath("mainsail-config")
     config_filename: str = "mainsail.cfg"
     config_section: str = f"include {config_filename}"
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
     repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
 
 
@@ -42,8 +41,8 @@ class MainsailData(BaseWebClient):
     display_name: str = name.capitalize()
     client_dir: Path = Path.home().joinpath("mainsail")
     config_file: Path = client_dir.joinpath("config.json")
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
     repo_path: str = "mainsail-crew/mainsail"
+    nginx_config: Path = NGINX_SITES_AVAILABLE.joinpath("mainsail")
     nginx_access_log: Path = Path("/var/log/nginx/mainsail-access.log")
     nginx_error_log: Path = Path("/var/log/nginx/mainsail-error.log")
     client_config: BaseWebClientConfig = None

kiauh/components/webui_client/menus/client_install_menu.py

@@ -0,0 +1,105 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.webui_client.base_data import BaseWebClient
+from components.webui_client.client_setup import install_client
+from components.webui_client.client_utils import (
+    get_client_port_selection,
+    get_nginx_listen_port,
+    set_listen_port,
+)
+from core.logger import Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.services.message_service import Message
+from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
+from core.types.color import Color
+from utils.sys_utils import cmd_sysctl_service, get_ipv4_addr
+
+
+# noinspection PyUnusedLocal
+class ClientInstallMenu(BaseMenu):
+    def __init__(
+        self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
+    ):
+        super().__init__()
+        self.title = f"Installation Menu > {client.display_name}"
+        self.title_color = Color.GREEN
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.client: BaseWebClient = client
+        self.settings = KiauhSettings()
+        self.client_settings: WebUiSettings = self.settings[client.name]
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.install_menu import InstallMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else InstallMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.reinstall_client),
+            "2": Option(method=self.change_listen_port),
+        }
+
+    def print_menu(self) -> None:
+        client_name = self.client.display_name
+        port = f"(Current: {Color.apply(self._get_current_port(), Color.GREEN)})"
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║  1) Reinstall {client_name:16}                        ║
+            ║  2) Reconfigure Listen Port {port:<34} ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def reinstall_client(self, **kwargs) -> None:
+        install_client(self.client, settings=self.settings, reinstall=True)
+
+    def change_listen_port(self, **kwargs) -> None:
+        curr_port = self._get_current_port()
+        new_port = get_client_port_selection(
+            self.client,
+            self.settings,
+            reconfigure=True,
+        )
+
+        cmd_sysctl_service("nginx", "stop")
+        set_listen_port(self.client, curr_port, new_port)
+
+        Logger.print_status("Saving new port configuration ...")
+        self.client_settings.port = new_port
+        self.settings.save()
+        Logger.print_ok("Port configuration saved!")
+
+        cmd_sysctl_service("nginx", "start")
+
+        # noinspection HttpUrlsUsage
+        message = Message(
+            title="Port reconfiguration complete!",
+            text=[
+                f"Open {self.client.display_name} now on: "
+                f"http://{get_ipv4_addr()}:{new_port}",
+            ],
+            color=Color.GREEN,
+        )
+        self.message_service.set_message(message)
+
+    def _get_current_port(self) -> int:
+        curr_port = get_nginx_listen_port(self.client.nginx_config)
+        if curr_port is None:
+            # if the port is not found in the config file we use
+            # the default port from the kiauh settings as fallback
+            return int(self.client_settings.port)
+        return curr_port

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -13,9 +13,9 @@ from typing import Type
 
 from components.webui_client import client_remove
 from components.webui_client.base_data import BaseWebClient
-from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
@@ -24,12 +24,14 @@ class ClientRemoveMenu(BaseMenu):
         self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
     ):
         super().__init__()
+        self.title = f"Remove {client.display_name}"
+        self.title_color = Color.RED
         self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.client: BaseWebClient = client
         self.remove_client: bool = False
         self.remove_client_cfg: bool = False
         self.backup_config_json: bool = False
-        self.selection_state: bool = False
+        self.select_state: bool = False
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
@@ -50,23 +52,19 @@ class ClientRemoveMenu(BaseMenu):
         client_config = self.client.client_config
         client_config_name = client_config.display_name
 
-        header = f" [ Remove {client_name} ] "
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        checked = f"[{Color.apply('x', Color.CYAN)}]"
         unchecked = "[ ]"
         o1 = checked if self.remove_client else unchecked
         o2 = checked if self.remove_client_cfg else unchecked
         o3 = checked if self.backup_config_json else unchecked
+        sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ Enter a number and hit enter to select / deselect     ║
             ║ the specific option for removal.                      ║
             ╟───────────────────────────────────────────────────────╢
-            ║  a) {self._get_selection_state_str():37}             ║
+            ║  a) {sel_state:49} ║
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove {client_name:16}                       ║
             ║  2) {o2} Remove {client_config_name:24}               ║
@@ -79,10 +77,10 @@ class ClientRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.selection_state = not self.selection_state
-        self.remove_client = self.selection_state
-        self.remove_client_cfg = self.selection_state
-        self.backup_config_json = self.selection_state
+        self.select_state = not self.select_state
+        self.remove_client = self.select_state
+        self.remove_client_cfg = self.select_state
+        self.backup_config_json = self.select_state
 
     def toggle_rm_client(self, **kwargs) -> None:
         self.remove_client = not self.remove_client
@@ -99,28 +97,18 @@ class ClientRemoveMenu(BaseMenu):
             and not self.remove_client_cfg
             and not self.backup_config_json
         ):
-            error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
-            print(error)
+            print(Color.apply("Nothing selected ...", Color.RED))
             return
 
-        client_remove.run_client_removal(
+        completion_msg = client_remove.run_client_removal(
             client=self.client,
             remove_client=self.remove_client,
             remove_client_cfg=self.remove_client_cfg,
             backup_config=self.backup_config_json,
         )
+        self.message_service.set_message(completion_msg)
 
         self.remove_client = False
         self.remove_client_cfg = False
         self.backup_config_json = False
-
-        self._go_back()
-
-    def _get_selection_state_str(self) -> str:
-        return (
-            "Select everything" if not self.selection_state else "Deselect everything"
-        )
-
-    def _go_back(self, **kwargs) -> None:
-        if self.previous_menu is not None:
-            self.previous_menu().run()
+        self.select_state = False

kiauh/core/backup_manager/backup_manager.py

@@ -1,98 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import shutil
-from pathlib import Path
-from typing import List
-
-from core.backup_manager import BACKUP_ROOT_DIR
-from core.logger import Logger
-from utils.common import get_current_date
-
-
-class BackupManagerException(Exception):
-    pass
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class BackupManager:
-    def __init__(self, backup_root_dir: Path = BACKUP_ROOT_DIR):
-        self._backup_root_dir: Path = backup_root_dir
-        self._ignore_folders: List[str] = []
-
-    @property
-    def backup_root_dir(self) -> Path:
-        return self._backup_root_dir
-
-    @backup_root_dir.setter
-    def backup_root_dir(self, value: Path):
-        self._backup_root_dir = value
-
-    @property
-    def ignore_folders(self) -> List[str]:
-        return self._ignore_folders
-
-    @ignore_folders.setter
-    def ignore_folders(self, value: List[str]):
-        self._ignore_folders = value
-
-    def backup_file(self, file: Path, target: Path | None = None, custom_filename=None):
-        Logger.print_status(f"Creating backup of {file} ...")
-
-        if not file.exists():
-            Logger.print_info("File does not exist! Skipping ...")
-            return
-
-        target = self.backup_root_dir if target is None else target
-
-        if Path(file).is_file():
-            date = get_current_date().get("date")
-            time = get_current_date().get("time")
-            filename = f"{file.stem}-{date}-{time}{file.suffix}"
-            filename = custom_filename if custom_filename is not None else filename
-            try:
-                Path(target).mkdir(exist_ok=True)
-                shutil.copyfile(file, target.joinpath(filename))
-                Logger.print_ok("Backup successful!")
-            except OSError as e:
-                Logger.print_error(f"Unable to backup '{file}':\n{e}")
-        else:
-            Logger.print_info(f"File '{file}' not found ...")
-
-    def backup_directory(
-        self, name: str, source: Path, target: Path | None = None
-    ) -> Path | None:
-        Logger.print_status(f"Creating backup of {name} in {target} ...")
-
-        if source is None or not Path(source).exists():
-            Logger.print_info("Source directory does not exist! Skipping ...")
-            return
-
-        target = self.backup_root_dir if target is None else target
-        try:
-            date = get_current_date().get("date")
-            time = get_current_date().get("time")
-            backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
-            shutil.copytree(source, backup_target, ignore=self.ignore_folders_func)
-            Logger.print_ok("Backup successful!")
-
-            return backup_target
-
-        except OSError as e:
-            Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
-            raise BackupManagerException(f"Unable to backup directory '{source}':\n{e}")
-
-    def ignore_folders_func(self, dirpath, filenames) -> List[str]:
-        return (
-            [f for f in filenames if f in self._ignore_folders]
-            if self._ignore_folders
-            else []
-        )

kiauh/core/constants.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -11,17 +11,6 @@ import os
 import pwd
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
-# text colors and formats
-COLOR_WHITE = "\033[37m"  # white
-COLOR_MAGENTA = "\033[35m"  # magenta
-COLOR_GREEN = "\033[92m"  # bright green
-COLOR_YELLOW = "\033[93m"  # bright yellow
-COLOR_RED = "\033[91m"  # bright red
-COLOR_CYAN = "\033[96m"  # bright cyan
-RESET_FORMAT = "\033[0m"  # reset format
-
 # global dependencies
 GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
 
@@ -33,7 +22,6 @@ CURRENT_USER = pwd.getpwuid(os.getuid())[0]
 
 # dirs
 SYSTEMD = Path("/etc/systemd/system")
-PRINTER_CFG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-cfg-backups")
 NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
 NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
 NGINX_CONFD = Path("/etc/nginx/conf.d")

kiauh/core/decorators.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/core/instance_manager/base_instance.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -16,8 +16,9 @@ from typing import List
 
 from utils.fs_utils import get_data_dir
 
-SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
-
+# suffixes that are not allowed to be used for instances
+# because they would cause conflicts with other components or are reserved
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion", "hmi"]
 
 @dataclass(repr=True)
 class BaseInstance:

kiauh/core/instance_manager/instance_manager.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/core/logger.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -12,78 +12,57 @@ import textwrap
 from enum import Enum
 from typing import List
 
-from core.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_MAGENTA,
-    COLOR_RED,
-    COLOR_WHITE,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
+from core.types.color import Color
 
 
 class DialogType(Enum):
-    INFO = ("INFO", COLOR_WHITE)
-    SUCCESS = ("SUCCESS", COLOR_GREEN)
-    ATTENTION = ("ATTENTION", COLOR_YELLOW)
-    WARNING = ("WARNING", COLOR_YELLOW)
-    ERROR = ("ERROR", COLOR_RED)
+    INFO = ("INFO", Color.WHITE)
+    SUCCESS = ("SUCCESS", Color.GREEN)
+    ATTENTION = ("ATTENTION", Color.YELLOW)
+    WARNING = ("WARNING", Color.YELLOW)
+    ERROR = ("ERROR", Color.RED)
     CUSTOM = (None, None)
 
 
-class DialogCustomColor(Enum):
-    WHITE = COLOR_WHITE
-    GREEN = COLOR_GREEN
-    YELLOW = COLOR_YELLOW
-    RED = COLOR_RED
-    CYAN = COLOR_CYAN
-    MAGENTA = COLOR_MAGENTA
-
-
 LINE_WIDTH = 53
 
 
+BORDER_TOP: str = "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
+BORDER_BOTTOM: str = "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
+BORDER_TITLE: str = "┠───────────────────────────────────────────────────────┨"
+BORDER_LEFT: str = "┃"
+BORDER_RIGHT: str = "┃"
+
+
 class Logger:
-    @staticmethod
-    def info(msg) -> None:
-        # log to kiauh.log
-        pass
-
-    @staticmethod
-    def warn(msg) -> None:
-        # log to kiauh.log
-        pass
-
-    @staticmethod
-    def error(msg) -> None:
-        # log to kiauh.log
-        pass
-
     @staticmethod
     def print_info(msg, prefix=True, start="", end="\n") -> None:
         message = f"[INFO] {msg}" if prefix else msg
-        print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
+        Logger.__print(Color.WHITE, start, message, end)
 
     @staticmethod
     def print_ok(msg: str = "Success!", prefix=True, start="", end="\n") -> None:
         message = f"[OK] {msg}" if prefix else msg
-        print(f"{COLOR_GREEN}{start}{message}{RESET_FORMAT}", end=end)
+        Logger.__print(Color.GREEN, start, message, end)
 
     @staticmethod
     def print_warn(msg, prefix=True, start="", end="\n") -> None:
         message = f"[WARN] {msg}" if prefix else msg
-        print(f"{COLOR_YELLOW}{start}{message}{RESET_FORMAT}", end=end)
+        Logger.__print(Color.YELLOW, start, message, end)
 
     @staticmethod
     def print_error(msg, prefix=True, start="", end="\n") -> None:
         message = f"[ERROR] {msg}" if prefix else msg
-        print(f"{COLOR_RED}{start}{message}{RESET_FORMAT}", end=end)
+        Logger.__print(Color.RED, start, message, end)
 
     @staticmethod
     def print_status(msg, prefix=True, start="", end="\n") -> None:
         message = f"\n###### {msg}" if prefix else msg
-        print(f"{COLOR_MAGENTA}{start}{message}{RESET_FORMAT}", end=end)
+        Logger.__print(Color.MAGENTA, start, message, end)
+
+    @staticmethod
+    def __print(color: Color, start: str, message: str, end: str) -> None:
+        print(Color.apply(f"{start}{message}", color), end=end)
 
     @staticmethod
     def print_dialog(
@@ -91,7 +70,7 @@ class Logger:
         content: List[str],
         center_content: bool = False,
         custom_title: str | None = None,
-        custom_color: DialogCustomColor | None = None,
+        custom_color: Color | None = None,
         margin_top: int = 0,
         margin_bottom: int = 0,
     ) -> None:
@@ -109,19 +88,32 @@ class Logger:
         :param margin_top: The number of empty lines to print before the dialog.
         :param margin_bottom: The number of empty lines to print after the dialog.
         """
-        dialog_color = Logger._get_dialog_color(title, custom_color)
+        color = Logger._get_dialog_color(title, custom_color)
         dialog_title = Logger._get_dialog_title(title, custom_title)
-        dialog_title_formatted = Logger._format_dialog_title(dialog_title)
-        dialog_content = Logger.format_content(content, LINE_WIDTH, center_content)
-        top = Logger._format_top_border(dialog_color)
-        bottom = Logger._format_bottom_border()
 
-        print("\n" * margin_top)
+        if margin_top > 0:
+            print("\n" * margin_top, end="")
+
+        print(Color.apply(BORDER_TOP, color))
+
+        if dialog_title:
+            print(Color.apply(f"┃ {dialog_title:^{LINE_WIDTH}} ┃", color))
+            print(Color.apply(BORDER_TITLE, color))
+
+        if content:
             print(
-            f"{top}{dialog_title_formatted}{dialog_content}{bottom}",
-            end="",
+                Logger.format_content(
+                    content,
+                    LINE_WIDTH,
+                    color,
+                    center_content,
                 )
-        print("\n" * margin_bottom)
+            )
+
+        print(Color.apply(BORDER_BOTTOM, color))
+
+        if margin_bottom > 0:
+            print("\n" * margin_bottom, end="")
 
     @staticmethod
     def _get_dialog_title(
@@ -133,39 +125,20 @@ class Logger:
 
     @staticmethod
     def _get_dialog_color(
-        title: DialogType, custom_color: DialogCustomColor | None = None
-    ) -> str:
+        title: DialogType, custom_color: Color | None = None
+    ) -> Color:
         if title == DialogType.CUSTOM and custom_color:
-            return str(custom_color.value)
+            return custom_color
 
-        color: str = title.value[1] if title.value[1] else DialogCustomColor.WHITE.value
+        color: Color = title.value[1] if title.value[1] else Color.WHITE
 
         return color
 
-    @staticmethod
-    def _format_top_border(color: str) -> str:
-        return f"{color}┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
-
-    @staticmethod
-    def _format_bottom_border() -> str:
-        return (
-            f"\n┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛{RESET_FORMAT}"
-        )
-
-    @staticmethod
-    def _format_dialog_title(title: str | None) -> str:
-        if title is not None:
-            return textwrap.dedent(f"""
-                ┃ {title:^{LINE_WIDTH}} ┃
-                ┠───────────────────────────────────────────────────────┨
-                """)
-        else:
-            return "\n"
-
     @staticmethod
     def format_content(
         content: List[str],
         line_width: int,
+        color: Color = Color.WHITE,
         center_content: bool = False,
         border_left: str = "┃",
         border_right: str = "┃",
@@ -184,11 +157,13 @@ class Logger:
 
         if not center_content:
             formatted_lines = [
-                f"{border_left} {line:<{line_width}} {border_right}" for line in lines
+                Color.apply(f"{border_left} {line:<{line_width}} {border_right}", color)
+                for line in lines
             ]
         else:
             formatted_lines = [
-                f"{border_left} {line:^{line_width}} {border_right}" for line in lines
+                Color.apply(f"{border_left} {line:^{line_width}} {border_right}", color)
+                for line in lines
             ]
 
         return "\n".join(formatted_lines)

kiauh/core/menus/__init__.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #

kiauh/core/menus/advanced_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -13,8 +13,10 @@ from typing import Type
 
 from components.klipper import KLIPPER_DIR
 from components.klipper.klipper import Klipper
+from components.klipper.klipper_utils import install_input_shaper_deps
 from components.klipper_firmware.menus.klipper_build_menu import (
     KlipperBuildFirmwareMenu,
+    KlipperKConfigMenu,
 )
 from components.klipper_firmware.menus.klipper_flash_menu import (
     KlipperFlashMethodMenu,
@@ -22,9 +24,9 @@ from components.klipper_firmware.menus.klipper_flash_menu import (
 )
 from components.moonraker import MOONRAKER_DIR
 from components.moonraker.moonraker import Moonraker
-from core.constants import COLOR_YELLOW, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 from procedures.system import change_system_hostname
 from utils.git_utils import rollback_repository
 
@@ -34,6 +36,8 @@ from utils.git_utils import rollback_repository
 class AdvancedMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
+        self.title = "Advanced Menu"
+        self.title_color = Color.YELLOW
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -47,26 +51,24 @@ class AdvancedMenu(BaseMenu):
             "2": Option(method=self.flash),
             "3": Option(method=self.build_flash),
             "4": Option(method=self.get_id),
-            "5": Option(method=self.klipper_rollback),
-            "6": Option(method=self.moonraker_rollback),
-            "7": Option(method=self.change_hostname),
+            "5": Option(method=self.input_shaper),
+            "6": Option(method=self.klipper_rollback),
+            "7": Option(method=self.moonraker_rollback),
+            "8": Option(method=self.change_hostname),
         }
 
     def print_menu(self) -> None:
-        header = " [ Advanced Menu ] "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            """
             ╟───────────────────────────┬───────────────────────────╢
             ║ Klipper Firmware:         │ Repository Rollback:      ║
-            ║  1) [Build]               │  5) [Klipper]             ║
-            ║  2) [Flash]               │  6) [Moonraker]           ║
+            ║  1) [Build]               │  6) [Klipper]             ║
+            ║  2) [Flash]               │  7) [Moonraker]           ║
             ║  3) [Build + Flash]       │                           ║
             ║  4) [Get MCU ID]          │ System:                   ║
-            ║                           │  7) [Change hostname]     ║
+            ║                           │  8) [Change hostname]     ║
+            ║ Extra Dependencies:       │                           ║
+            ║  5) [Input Shaper]        │                           ║
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
@@ -79,12 +81,15 @@ class AdvancedMenu(BaseMenu):
         rollback_repository(MOONRAKER_DIR, Moonraker)
 
     def build(self, **kwargs) -> None:
+        KlipperKConfigMenu().run()
         KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
 
     def flash(self, **kwargs) -> None:
+        KlipperKConfigMenu().run()
         KlipperFlashMethodMenu(previous_menu=self.__class__).run()
 
     def build_flash(self, **kwargs) -> None:
+        KlipperKConfigMenu().run()
         KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
         KlipperFlashMethodMenu(previous_menu=self.__class__).run()
 
@@ -96,3 +101,6 @@ class AdvancedMenu(BaseMenu):
 
     def change_hostname(self, **kwargs) -> None:
         change_system_hostname()
+
+    def input_shaper(self, **kwargs) -> None:
+        install_input_shaper_deps()

kiauh/core/menus/backup_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -13,7 +13,7 @@ from typing import Type
 
 from components.klipper.klipper_utils import backup_klipper_dir
 from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
-from components.moonraker.moonraker_utils import (
+from components.moonraker.utils.utils import (
     backup_moonraker_db_dir,
     backup_moonraker_dir,
 )
@@ -23,10 +23,10 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.common import backup_printer_config_dir
+from core.services.backup_service import BackupService
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
@@ -34,6 +34,8 @@ from utils.common import backup_printer_config_dir
 class BackupMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
+        self.title = "Backup Menu"
+        self.title_color = Color.GREEN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -55,14 +57,11 @@ class BackupMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ Backup Menu ] "
-        line1 = f"{COLOR_YELLOW}INFO: Backups are located in '~/kiauh-backups'{RESET_FORMAT}"
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
+        line1 = Color.apply(
+            "INFO: Backups are located in '~/kiauh_backups'", Color.YELLOW
+        )
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
             ║ {line1:^62} ║
             ╟───────────────────────────┬───────────────────────────╢
@@ -87,7 +86,7 @@ class BackupMenu(BaseMenu):
         backup_moonraker_dir()
 
     def backup_printer_config(self, **kwargs) -> None:
-        backup_printer_config_dir()
+        BackupService().backup_printer_config_dir()
 
     def backup_moonraker_db(self, **kwargs) -> None:
         backup_moonraker_db_dir()

kiauh/core/menus/base_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -14,36 +14,33 @@ import sys
 import textwrap
 import traceback
 from abc import abstractmethod
+from enum import Enum
 from typing import Dict, Type
 
-from core.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
 from core.logger import Logger
 from core.menus import FooterType, Option
+from core.services.message_service import MessageService
+from core.spinner import Spinner
+from core.types.color import Color
 from utils.input_utils import get_selection_input
 
 
 def clear() -> None:
-    subprocess.call("clear", shell=True)
+    subprocess.call("clear -x", shell=True)
 
 
 def print_header() -> None:
     line1 = " [ KIAUH ] "
     line2 = "Klipper Installation And Update Helper"
     line3 = ""
-    color = COLOR_CYAN
-    count = 62 - len(color) - len(RESET_FORMAT)
+    color = Color.CYAN
+    count = 62 - len(str(color)) - len(str(Color.RST))
     header = textwrap.dedent(
         f"""
         ╔═══════════════════════════════════════════════════════╗
-        ║ {color}{line1:~^{count}}{RESET_FORMAT} ║
-        ║ {color}{line2:^{count}}{RESET_FORMAT} ║
-        ║ {color}{line3:~^{count}}{RESET_FORMAT} ║
+        ║ {Color.apply(f"{line1:~^{count}}", color)} ║
+        ║ {Color.apply(f"{line2:^{count}}", color)} ║
+        ║ {Color.apply(f"{line3:~^{count}}", color)} ║
         ╚═══════════════════════════════════════════════════════╝
         """
     )[1:]
@@ -52,11 +49,11 @@ def print_header() -> None:
 
 def print_quit_footer() -> None:
     text = "Q) Quit"
-    color = COLOR_RED
-    count = 62 - len(color) - len(RESET_FORMAT)
+    color = Color.RED
+    count = 62 - len(str(color)) - len(str(Color.RST))
     footer = textwrap.dedent(
         f"""
-        ║ {color}{text:^{count}}{RESET_FORMAT} ║
+        ║ {color}{text:^{count}}{Color.RST} ║
         ╚═══════════════════════════════════════════════════════╝
         """
     )[1:]
@@ -65,11 +62,11 @@ def print_quit_footer() -> None:
 
 def print_back_footer() -> None:
     text = "B) « Back"
-    color = COLOR_GREEN
-    count = 62 - len(color) - len(RESET_FORMAT)
+    color = Color.GREEN
+    count = 62 - len(str(color)) - len(str(Color.RST))
     footer = textwrap.dedent(
         f"""
-        ║ {color}{text:^{count}}{RESET_FORMAT} ║
+        ║ {color}{text:^{count}}{Color.RST} ║
         ╚═══════════════════════════════════════════════════════╝
         """
     )[1:]
@@ -79,12 +76,12 @@ def print_back_footer() -> None:
 def print_back_help_footer() -> None:
     text1 = "B) « Back"
     text2 = "H) Help [?]"
-    color1 = COLOR_GREEN
-    color2 = COLOR_YELLOW
-    count = 34 - len(color1) - len(RESET_FORMAT)
+    color1 = Color.GREEN
+    color2 = Color.YELLOW
+    count = 34 - len(str(color1)) - len(str(Color.RST))
     footer = textwrap.dedent(
         f"""
-        ║ {color1}{text1:^{count}}{RESET_FORMAT} │ {color2}{text2:^{count}}{RESET_FORMAT} ║
+        ║ {color1}{text1:^{count}}{Color.RST} │ {color2}{text2:^{count}}{Color.RST} ║
         ╚═══════════════════════════╧═══════════════════════════╝
         """
     )[1:]
@@ -95,6 +92,11 @@ def print_blank_footer() -> None:
     print("╚═══════════════════════════════════════════════════════╝")
 
 
+class MenuTitleStyle(Enum):
+    PLAIN = "plain"
+    STYLED = "styled"
+
+
 class PostInitCaller(type):
     def __call__(cls, *args, **kwargs):
         obj = type.__call__(cls, *args, **kwargs)
@@ -110,10 +112,20 @@ class BaseMenu(metaclass=PostInitCaller):
     default_option: Option = None
     input_label_txt: str = "Perform action"
     header: bool = False
+
+    loading_msg: str = ""
+    spinner: Spinner | None = None
+
+    title: str = ""
+    title_style: MenuTitleStyle = MenuTitleStyle.STYLED
+    title_color: Color = Color.WHITE
+
     previous_menu: Type[BaseMenu] | None = None
     help_menu: Type[BaseMenu] | None = None
     footer_type: FooterType = FooterType.BACK
 
+    message_service = MessageService()
+
     def __init__(self, **kwargs) -> None:
         if type(self) is BaseMenu:
             raise NotImplementedError("BaseMenu cannot be instantiated directly.")
@@ -160,7 +172,32 @@ class BaseMenu(metaclass=PostInitCaller):
     def print_menu(self) -> None:
         raise NotImplementedError
 
-    def print_footer(self) -> None:
+    def is_loading(self, state: bool) -> None:
+        if not self.spinner and state:
+            self.spinner = Spinner(self.loading_msg)
+            self.spinner.start()
+        else:
+            self.spinner.stop()
+            self.spinner = None
+
+    def __print_menu_title(self) -> None:
+        count = 62 - len(str(self.title_color)) - len(str(Color.RST))
+        menu_title = "╔═══════════════════════════════════════════════════════╗\n"
+        if self.title:
+            title = (
+                f" [ {self.title} ] "
+                if self.title_style == MenuTitleStyle.STYLED
+                else self.title
+            )
+            line = (
+                f"{title:~^{count}}"
+                if self.title_style == MenuTitleStyle.STYLED
+                else f"{title:^{count}}"
+            )
+            menu_title += f"║ {Color.apply(line, self.title_color)} ║\n"
+        print(menu_title, end="")
+
+    def __print_footer(self) -> None:
         if self.footer_type is FooterType.QUIT:
             print_quit_footer()
         elif self.footer_type is FooterType.BACK:
@@ -172,16 +209,20 @@ class BaseMenu(metaclass=PostInitCaller):
         else:
             raise NotImplementedError("FooterType not correctly implemented!")
 
-    def display_menu(self) -> None:
+    def __display_menu(self) -> None:
+        self.message_service.display_message()
+
         if self.header:
             print_header()
+
+        self.__print_menu_title()
         self.print_menu()
-        self.print_footer()
+        self.__print_footer()
 
     def run(self) -> None:
         """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
         try:
-            self.display_menu()
+            self.__display_menu()
             option = get_selection_input(self.input_label_txt, self.options)
             selected_option: Option = self.options.get(option)
 

kiauh/core/menus/install_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -12,16 +12,20 @@ import textwrap
 from typing import Type
 
 from components.crowsnest.crowsnest import install_crowsnest
-from components.klipper import klipper_setup
+from components.klipper.services.klipper_setup_service import KlipperSetupService
 from components.klipperscreen.klipperscreen import install_klipperscreen
-from components.moonraker import moonraker_setup
-from components.webui_client import client_setup
-from components.webui_client.client_config import client_config_setup
+from components.moonraker.services.moonraker_setup_service import MoonrakerSetupService
+from components.webui_client.client_config.client_config_setup import (
+    install_client_config,
+)
+from components.webui_client.client_setup import install_client
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.constants import COLOR_GREEN, RESET_FORMAT
+from components.webui_client.menus.client_install_menu import ClientInstallMenu
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
@@ -29,7 +33,11 @@ from core.menus.base_menu import BaseMenu
 class InstallMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
+        self.title = "Installation Menu"
+        self.title_color = Color.GREEN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.klsvc = KlipperSetupService()
+        self.mrsvc = MoonrakerSetupService()
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
@@ -49,13 +57,8 @@ class InstallMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ Installation Menu ] "
-        color = COLOR_GREEN
-        count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            """
             ╟───────────────────────────┬───────────────────────────╢
             ║ Firmware & API:           │ Touchscreen GUI:          ║
             ║  1) [Klipper]             │  7) [KlipperScreen]       ║
@@ -74,22 +77,30 @@ class InstallMenu(BaseMenu):
         print(menu, end="")
 
     def install_klipper(self, **kwargs) -> None:
-        klipper_setup.install_klipper()
+        self.klsvc.install()
 
     def install_moonraker(self, **kwargs) -> None:
-        moonraker_setup.install_moonraker()
+        self.mrsvc.install()
 
     def install_mainsail(self, **kwargs) -> None:
-        client_setup.install_client(MainsailData())
+        client: MainsailData = MainsailData()
+        if client.client_dir.exists():
+            ClientInstallMenu(client, self.__class__).run()
+        else:
+            install_client(client, settings=KiauhSettings())
 
     def install_mainsail_config(self, **kwargs) -> None:
-        client_config_setup.install_client_config(MainsailData())
+        install_client_config(MainsailData())
 
     def install_fluidd(self, **kwargs) -> None:
-        client_setup.install_client(FluiddData())
+        client: FluiddData = FluiddData()
+        if client.client_dir.exists():
+            ClientInstallMenu(client, self.__class__).run()
+        else:
+            install_client(client, settings=KiauhSettings())
 
     def install_fluidd_config(self, **kwargs) -> None:
-        client_config_setup.install_client_config(FluiddData())
+        install_client_config(FluiddData())
 
     def install_klipperscreen(self, **kwargs) -> None:
         install_klipperscreen()

kiauh/core/menus/main_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -16,21 +16,13 @@ from components.crowsnest.crowsnest import get_crowsnest_status
 from components.klipper.klipper_utils import get_klipper_status
 from components.klipperscreen.klipperscreen import get_klipperscreen_status
 from components.log_uploads.menus.log_upload_menu import LogUploadMenu
-from components.moonraker.moonraker_utils import get_moonraker_status
+from components.moonraker.utils.utils import get_moonraker_status
 from components.webui_client.client_utils import (
     get_client_status,
     get_current_client_config,
 )
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_MAGENTA,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
 from core.logger import Logger
 from core.menus import FooterType
 from core.menus.advanced_menu import AdvancedMenu
@@ -40,7 +32,8 @@ from core.menus.install_menu import InstallMenu
 from core.menus.remove_menu import RemoveMenu
 from core.menus.settings_menu import SettingsMenu
 from core.menus.update_menu import UpdateMenu
-from core.types import ComponentStatus, StatusMap, StatusText
+from core.types.color import Color
+from core.types.component_status import ComponentStatus, StatusMap, StatusText
 from extensions.extensions_menu import ExtensionsMenu
 from utils.common import get_kiauh_version, trunc_string
 
@@ -52,6 +45,8 @@ class MainMenu(BaseMenu):
         super().__init__()
 
         self.header: bool = True
+        self.title = "Main Menu"
+        self.title_color = Color.CYAN
         self.footer_type: FooterType = FooterType.QUIT
 
         self.version = ""
@@ -83,7 +78,7 @@ class MainMenu(BaseMenu):
             setattr(
                 self,
                 f"{var}_status",
-                f"{COLOR_RED}Not installed{RESET_FORMAT}",
+                Color.apply("Not installed", Color.RED),
             )
 
     def _fetch_status(self) -> None:
@@ -109,34 +104,30 @@ class MainMenu(BaseMenu):
             count_txt = f": {instance_count}"
 
         setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
-        setattr(self, f"{name}_owner", f"{COLOR_CYAN}{owner}{RESET_FORMAT}")
-        setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
+        setattr(self, f"{name}_owner", Color.apply(owner, Color.CYAN))
+        setattr(self, f"{name}_repo", Color.apply(repo, Color.CYAN))
 
     def _format_by_code(self, code: int, status: str, count: str) -> str:
-        color = COLOR_RED
+        color = Color.RED
         if code == 0:
-            color = COLOR_RED
+            color = Color.RED
         elif code == 1:
-            color = COLOR_YELLOW
+            color = Color.YELLOW
         elif code == 2:
-            color = COLOR_GREEN
+            color = Color.GREEN
 
-        return f"{color}{status}{count}{RESET_FORMAT}"
+        return Color.apply(f"{status}{count}", color)
 
     def print_menu(self) -> None:
         self._fetch_status()
 
-        header = " [ Main Menu ] "
-        footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
-        footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
+        footer1 = Color.apply(self.version, Color.CYAN)
+        link = Color.apply("https://git.io/JnmlX", Color.MAGENTA)
+        footer2 = f"Changelog: {link}"
         pad1 = 32
         pad2 = 26
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟──────────────────┬────────────────────────────────────╢
             ║  0) [Log-Upload] │   Klipper: {self.kl_status:<{pad1}} ║
             ║                  │     Owner: {self.kl_owner:<{pad1}} ║

kiauh/core/menus/remove_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -20,9 +20,9 @@ from components.moonraker.menus.moonraker_remove_menu import (
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
 from components.webui_client.menus.client_remove_menu import ClientRemoveMenu
-from core.constants import COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 
 
 # noinspection PyUnusedLocal
@@ -30,6 +30,8 @@ from core.menus.base_menu import BaseMenu
 class RemoveMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
+        self.title = "Remove Menu"
+        self.title_color = Color.RED
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -48,13 +50,8 @@ class RemoveMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        header = " [ Remove Menu ] "
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            """
             ╟───────────────────────────────────────────────────────╢
             ║ INFO: Configurations and/or any backups will be kept! ║
             ╟───────────────────────────┬───────────────────────────╢

kiauh/core/menus/repo_select_menu.py

@@ -0,0 +1,162 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from typing import List, Literal, Type
+
+from core.logger import Logger, DialogType
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.settings.kiauh_settings import KiauhSettings, Repository
+from core.types.color import Color
+from procedures.switch_repo import run_switch_repo_routine
+from utils.input_utils import get_string_input, get_number_input, get_confirm
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class RepoSelectMenu(BaseMenu):
+    def __init__(
+        self,
+        name: Literal["klipper", "moonraker"],
+        repos: List[Repository],
+        previous_menu: Type[BaseMenu] | None = None,
+    ) -> None:
+        super().__init__()
+        self.title_color = Color.CYAN
+        self.previous_menu = previous_menu
+        self.settings = KiauhSettings()
+        self.input_label_txt = "Select repository"
+        self.name = name
+        self.repos = repos
+
+        if self.name == "klipper":
+            self.title = "Klipper Repository Selection Menu"
+
+        elif self.name == "moonraker":
+            self.title = "Moonraker Repository Selection Menu"
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.settings_menu import SettingsMenu
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else SettingsMenu
+        )
+
+    def set_options(self) -> None:
+        self.options = {}
+        if self.repos:
+            for idx, repo in enumerate(self.repos, start=1):
+                self.options[str(idx)] = Option(
+                    method=self.select_repository, opt_data=repo
+                )
+        self.options["a"] = Option(method=self.add_repository)
+        self.options["r"] = Option(method=self.remove_repository)
+        self.options["b"] = Option(method=self.go_back)
+
+    def print_menu(self) -> None:
+        menu = "╟───────────────────────────────────────────────────────╢\n"
+        menu += "║ Available Repositories:                               ║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+        for idx, repo in enumerate(self.repos, start=1):
+            url = f"● Repo: {repo.url.replace('.git', '')}"
+            branch = f"└► Branch: {repo.branch}"
+            menu += f"║ {idx}) {Color.apply(url, Color.CYAN):<59} ║\n"
+            menu += f"║    {Color.apply(branch, Color.CYAN):<59} ║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+        menu += "║ A) Add repository                                     ║\n"
+        menu += "║ R) Remove repository                                  ║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+        print(menu, end="")
+
+    def select_repository(self, **kwargs) -> None:
+        repo: Repository = kwargs.get("opt_data")
+        Logger.print_status(
+            f"Switching to {self.name.capitalize()}'s new source repository ..."
+        )
+        run_switch_repo_routine(self.name, repo.url, repo.branch)
+
+    def add_repository(self, **kwargs) -> None:
+        while True:
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                custom_title="Enter the repository URL",
+                content=[
+                    "NOTE: There is no input validation in place, "
+                    "please check your input for correctness",
+                ],
+            )
+            url = get_string_input("Repository URL", allow_special_chars=True).strip()
+
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                custom_title="Enter the branch name",
+                content=[ "Press Enter to use the default branch (master)." ],
+                center_content=False,
+            )
+            branch = get_string_input("Branch", allow_special_chars=True, default="master").strip()
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                custom_title="Summary",
+                content=[
+                    f"● URL:    {url}",
+                    f"● Branch: {branch}",
+                ],
+            )
+            confirm = get_confirm("Save repository")
+            if confirm:
+                repo = Repository(url, branch)
+                if self.name == "klipper":
+                    self.settings.klipper.repositories.append(repo)
+                    self.settings.save()
+                    self.repos = self.settings.klipper.repositories
+                else:
+                    self.settings.moonraker.repositories.append(repo)
+                    self.settings.save()
+                    self.repos = self.settings.moonraker.repositories
+                Logger.print_ok("Repository added and saved.")
+
+                # Refresh menu to show new repo immediately and update options
+                self.set_options()
+                self.run()
+                break
+            else:
+                Logger.print_info("Operation cancelled by user.")
+                break
+
+    def remove_repository(self, **kwargs) -> None:
+        repos = self.repos
+        if not repos:
+            Logger.print_info("No repositories configured.")
+            return
+        repo_lines = [f"{idx}) {repo.url} [{repo.branch}]" for idx, repo in enumerate(repos, start=1)]
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            custom_title="Available Repositories",
+            content=[*repo_lines],
+        )
+        idx = get_number_input("Select the repository to remove", 1, len(repos))
+        removed = repos.pop(idx - 1)
+        if self.name == "klipper":
+            self.settings.klipper.repositories = repos
+            self.settings.save()
+            self.repos = self.settings.klipper.repositories
+        else:
+            self.settings.moonraker.repositories = repos
+            self.settings.save()
+            self.repos = self.settings.moonraker.repositories
+        Logger.print_ok(f"Removed repository: {removed.url} [{removed.branch}]")
+
+        # Refresh menu to show updated repo list and options
+        self.set_options()
+        self.run()
+
+    def go_back(self, **kwargs) -> None:
+        from core.menus.settings_menu import SettingsMenu
+        SettingsMenu().run()

kiauh/core/menus/settings_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -9,15 +9,17 @@
 from __future__ import annotations
 
 import textwrap
-from typing import Literal, Tuple, Type
+from typing import Type
 
-from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
+from components.klipper.klipper_utils import get_klipper_status
+from components.moonraker.utils.utils import get_moonraker_status
 from core.logger import DialogType, Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from core.settings.kiauh_settings import KiauhSettings, RepoSettings
-from procedures.switch_repo import run_switch_repo_routine
-from utils.input_utils import get_confirm, get_string_input
+from core.menus.repo_select_menu import RepoSelectMenu
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
+from core.types.component_status import ComponentStatus
 
 
 # noinspection PyUnusedLocal
@@ -25,12 +27,20 @@ from utils.input_utils import get_confirm, get_string_input
 class SettingsMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
+        self.title = "Settings Menu"
+        self.title_color = Color.CYAN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.klipper_repo: str | None = None
-        self.moonraker_repo: str | None = None
+
         self.mainsail_unstable: bool | None = None
         self.fluidd_unstable: bool | None = None
         self.auto_backups_enabled: bool | None = None
+
+        na: str = "Not available!"
+        self.kl_repo_url: str = Color.apply(na, Color.RED)
+        self.kl_branch: str = Color.apply(na, Color.RED)
+        self.mr_repo_url: str = Color.apply(na, Color.RED)
+        self.mr_branch: str = Color.apply(na, Color.RED)
+
         self._load_settings()
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -40,48 +50,39 @@ class SettingsMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.set_klipper_repo),
-            "2": Option(method=self.set_moonraker_repo),
+            "1": Option(method=self.switch_klipper_repo),
+            "2": Option(method=self.switch_moonraker_repo),
             "3": Option(method=self.toggle_mainsail_release),
             "4": Option(method=self.toggle_fluidd_release),
             "5": Option(method=self.toggle_backup_before_update),
         }
 
     def print_menu(self) -> None:
-        header = " [ KIAUH Settings ] "
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        checked = f"[{COLOR_GREEN}x{RESET_FORMAT}]"
+        checked = f"[{Color.apply('x', Color.GREEN)}]"
         unchecked = "[ ]"
+
         o1 = checked if self.mainsail_unstable else unchecked
         o2 = checked if self.fluidd_unstable else unchecked
         o3 = checked if self.auto_backups_enabled else unchecked
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────────────────────────────────────╢
-            ║ Klipper source repository:                            ║
-            ║   ● {self.klipper_repo:<67} ║
-            ║                                                       ║
-            ║ Moonraker source repository:                          ║
-            ║   ● {self.moonraker_repo:<67} ║
-            ║                                                       ║
-            ║ Install unstable Webinterface releases:               ║
-            ║  {o1} Mainsail                                         ║
-            ║  {o2} Fluidd                                           ║
-            ║                                                       ║
+            ║ 1) Switch Klipper source repository                   ║
+            ║    ● Current repository:                              ║
+            ║    └► Repo: {self.kl_repo_url:50} ║
+            ║    └► Branch: {self.kl_branch:48} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 2) Switch Moonraker source repository                 ║
+            ║    ● Current repository:                              ║
+            ║    └► Repo: {self.mr_repo_url:50} ║
+            ║    └► Branch: {self.mr_branch:48} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Install unstable releases:                            ║
+            ║ 3) {o1} Mainsail                                       ║
+            ║ 4) {o2} Fluidd                                         ║
+            ╟───────────────────────────────────────────────────────╢
             ║ Auto-Backup:                                          ║
-            ║  {o3} Automatic backup before update                   ║
-            ║                                                       ║
-            ╟───────────────────────────────────────────────────────╢
-            ║ 1) Set Klipper source repository                      ║
-            ║ 2) Set Moonraker source repository                    ║
-            ║                                                       ║
-            ║ 3) Toggle unstable Mainsail releases                  ║
-            ║ 4) Toggle unstable Fluidd releases                    ║
-            ║                                                       ║
-            ║ 5) Toggle automatic backups before updates            ║
+            ║ 5) {o3} Backup before update                           ║
             ╟───────────────────────────────────────────────────────╢
             """
         )[1:]
@@ -89,89 +90,39 @@ class SettingsMenu(BaseMenu):
 
     def _load_settings(self) -> None:
         self.settings = KiauhSettings()
-
-        self._format_repo_str("klipper")
-        self._format_repo_str("moonraker")
-
         self.auto_backups_enabled = self.settings.kiauh.backup_before_update
         self.mainsail_unstable = self.settings.mainsail.unstable_releases
         self.fluidd_unstable = self.settings.fluidd.unstable_releases
 
-    def _format_repo_str(self, repo_name: Literal["klipper", "moonraker"]) -> None:
-        repo: RepoSettings = self.settings[repo_name]
-        repo_str = f"{'/'.join(repo.repo_url.rsplit('/', 2)[-2:])}"
-        branch_str = f"({COLOR_CYAN}@ {repo.branch}{RESET_FORMAT})"
+        klipper_status: ComponentStatus = get_klipper_status()
+        moonraker_status: ComponentStatus = get_moonraker_status()
 
-        setattr(
-            self,
-            f"{repo_name}_repo",
-            f"{COLOR_CYAN}{repo_str}{RESET_FORMAT} {branch_str}",
-        )
+        def trim_repo_url(repo: str) -> str:
+            return repo.replace(".git", "").replace("https://", "").replace("git@", "")
 
-    def _gather_input(self) -> Tuple[str, str]:
+        if not klipper_status.repo == "-":
+            url = trim_repo_url(klipper_status.repo_url)
+            self.kl_repo_url = Color.apply(url, Color.CYAN)
+            self.kl_branch = Color.apply(klipper_status.branch, Color.CYAN)
+        if not moonraker_status.repo == "-":
+            url = trim_repo_url(moonraker_status.repo_url)
+            self.mr_repo_url = Color.apply(url, Color.CYAN)
+            self.mr_branch = Color.apply(moonraker_status.branch, Color.CYAN)
+
+    def _warn_no_repos(self, name: str) -> None:
         Logger.print_dialog(
-            DialogType.ATTENTION,
-            [
-                "There is no input validation in place! Make sure your the input is "
-                "valid and has no typos or invalid characters! For the change to take "
-                "effect, the new repository will be cloned. A backup of the old "
-                "repository will be created.",
-                "\n\n",
-                "Make sure you don't have any ongoing prints running, as the services "
-                "will be restarted during this process! You will loose any ongoing print!",
-            ],
-        )
-        repo = get_string_input(
-            "Enter new repository URL",
-            allow_special_chars=True,
-        )
-        branch = get_string_input(
-            "Enter new branch name",
-            allow_special_chars=True,
+            DialogType.WARNING,
+            [f"No {name} repositories configured in kiauh.cfg!"],
+            center_content=True,
         )
 
-        return repo, branch
+    def switch_klipper_repo(self, **kwargs) -> None:
+        repos = self.settings.klipper.repositories
+        RepoSelectMenu("klipper", repos=repos, previous_menu=self.__class__).run()
 
-    def _set_repo(self, repo_name: Literal["klipper", "moonraker"]) -> None:
-        repo_url, branch = self._gather_input()
-        display_name = repo_name.capitalize()
-        Logger.print_dialog(
-            DialogType.CUSTOM,
-            [
-                f"New {display_name} repository URL:",
-                f"● {repo_url}",
-                f"New {display_name} repository branch:",
-                f"● {branch}",
-            ],
-        )
-
-        if get_confirm("Apply changes?", allow_go_back=True):
-            repo: RepoSettings = self.settings[repo_name]
-            repo.repo_url = repo_url
-            repo.branch = branch
-
-            self.settings.save()
-            self._load_settings()
-
-            Logger.print_ok("Changes saved!")
-        else:
-            Logger.print_info(
-                f"Skipping change of {display_name} source repository  ..."
-            )
-            return
-
-        Logger.print_status(f"Switching to {display_name}'s new source repository ...")
-        self._switch_repo(repo_name)
-
-    def _switch_repo(self, name: Literal["klipper", "moonraker"]) -> None:
-        repo: RepoSettings = self.settings[name]
-        run_switch_repo_routine(name, repo)
-
-    def set_klipper_repo(self, **kwargs) -> None:
-        self._set_repo("klipper")
-
-    def set_moonraker_repo(self, **kwargs) -> None:
-        self._set_repo("moonraker")
+    def switch_moonraker_repo(self, **kwargs) -> None:
+        repos = self.settings.moonraker.repositories
+        RepoSelectMenu("moonraker", repos=repos, previous_menu=self.__class__).run()
 
     def toggle_mainsail_release(self, **kwargs) -> None:
         self.mainsail_unstable = not self.mainsail_unstable

kiauh/core/menus/update_menu.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -12,16 +12,16 @@ import textwrap
 from typing import Callable, List, Type
 
 from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
-from components.klipper.klipper_setup import update_klipper
 from components.klipper.klipper_utils import (
     get_klipper_status,
 )
+from components.klipper.services.klipper_setup_service import KlipperSetupService
 from components.klipperscreen.klipperscreen import (
     get_klipperscreen_status,
     update_klipperscreen,
 )
-from components.moonraker.moonraker_setup import update_moonraker
-from components.moonraker.moonraker_utils import get_moonraker_status
+from components.moonraker.services.moonraker_setup_service import MoonrakerSetupService
+from components.moonraker.utils.utils import get_moonraker_status
 from components.webui_client.client_config.client_config_setup import (
     update_client_config,
 )
@@ -32,17 +32,11 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.constants import (
-    COLOR_GREEN,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
 from core.logger import DialogType, Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from core.spinner import Spinner
-from core.types import ComponentStatus
+from core.types.color import Color
+from core.types.component_status import ComponentStatus
 from utils.input_utils import get_confirm
 from utils.sys_utils import (
     get_upgradable_packages,
@@ -56,6 +50,11 @@ from utils.sys_utils import (
 class UpdateMenu(BaseMenu):
     def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
+        self.loading_msg = "Loading update menu, please wait"
+        self.is_loading(True)
+
+        self.title = "Update Menu"
+        self.title_color = Color.GREEN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
 
         self.packages: List[str] = []
@@ -123,6 +122,9 @@ class UpdateMenu(BaseMenu):
             },
         }
 
+        self._fetch_update_status()
+        self.is_loading(False)
+
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
@@ -143,29 +145,16 @@ class UpdateMenu(BaseMenu):
         }
 
     def print_menu(self) -> None:
-        spinner = Spinner("Loading update menu, please wait", color="green")
-        spinner.start()
-
-        self._fetch_update_status()
-
-        spinner.stop()
-
-        header = " [ Update Menu ] "
-        color = COLOR_GREEN
-        count = 62 - len(color) - len(RESET_FORMAT)
-
         sysupgrades: str = "No upgrades available."
         padding = 29
         if self.package_count > 0:
-            sysupgrades = (
-                f"{COLOR_GREEN}{self.package_count} upgrades available!{RESET_FORMAT}"
+            sysupgrades = Color.apply(
+                f"{self.package_count} upgrades available!", Color.GREEN
             )
             padding = 38
 
         menu = textwrap.dedent(
             f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟───────────────────────┬───────────────┬───────────────╢
             ║  a) Update all        │               │               ║
             ║                       │ Current:      │ Latest:       ║
@@ -204,10 +193,12 @@ class UpdateMenu(BaseMenu):
         self.upgrade_system_packages()
 
     def update_klipper(self, **kwargs) -> None:
-        self._run_update_routine("klipper", update_klipper)
+        klsvc = KlipperSetupService()
+        self._run_update_routine("klipper", klsvc.update)
 
     def update_moonraker(self, **kwargs) -> None:
-        self._run_update_routine("moonraker", update_moonraker)
+        mrsvc = MoonrakerSetupService()
+        self._run_update_routine("moonraker", mrsvc.update)
 
     def update_mainsail(self, **kwargs) -> None:
         self._run_update_routine(
@@ -265,15 +256,15 @@ class UpdateMenu(BaseMenu):
         self.package_count = len(self.packages)
 
     def _format_local_status(self, local_version, remote_version) -> str:
-        color = COLOR_RED
+        color = Color.RED
         if not local_version:
-            color = COLOR_RED
+            color = Color.RED
         elif local_version == remote_version:
-            color = COLOR_GREEN
+            color = Color.GREEN
         elif local_version != remote_version:
-            color = COLOR_YELLOW
+            color = Color.YELLOW
 
-        return f"{color}{local_version or '-'}{RESET_FORMAT}"
+        return Color.apply(local_version or "-", color)
 
     def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
         comp_status: ComponentStatus = status_fn(*args)
@@ -288,9 +279,9 @@ class UpdateMenu(BaseMenu):
         local_status = self.status_data[name].get("local", None)
         remote_status = self.status_data[name].get("remote", None)
 
-        color = COLOR_GREEN if remote_status else COLOR_RED
+        color = Color.GREEN if remote_status else Color.RED
         local_txt = self._format_local_status(local_status, remote_status)
-        remote_txt = f"{color}{remote_status or '-'}{RESET_FORMAT}"
+        remote_txt = Color.apply(remote_status or "-", color)
 
         setattr(self, f"{name}_local", local_txt)
         setattr(self, f"{name}_remote", remote_txt)

kiauh/core/services/backup_service.py

@@ -0,0 +1,198 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+from datetime import datetime
+from pathlib import Path
+from typing import List, Optional
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.logger import Logger
+from utils.instance_utils import get_instances
+
+
+class BackupService:
+    def __init__(self):
+        self._backup_root = Path.home().joinpath("kiauh_backups")
+
+    @property
+    def backup_root(self) -> Path:
+        return self._backup_root
+
+    @property
+    def timestamp(self) -> str:
+        return datetime.now().strftime("%Y%m%d-%H%M%S")
+
+    ################################################
+    # GENERIC BACKUP METHODS
+    ################################################
+
+    def backup_file(
+        self,
+        source_path: Path,
+        target_path: Optional[Path | str] = None,
+        target_name: Optional[str] = None,
+    ) -> bool:
+        source_path = Path(source_path)
+
+        Logger.print_status(f"Creating backup of {source_path} ...")
+
+        if not source_path.exists():
+            Logger.print_info(
+                f"File '{source_path}' does not exist! Skipping backup..."
+            )
+            return False
+
+        if not source_path.is_file():
+            Logger.print_info(f"'{source_path}' is not a file! Skipping backup...")
+            return False
+
+        try:
+            self._backup_root.mkdir(parents=True, exist_ok=True)
+
+            filename = (
+                target_name
+                or f"{source_path.stem}_{self.timestamp}{source_path.suffix}"
+            )
+
+            backup_dir = self._backup_root
+            if target_path is not None:
+                backup_dir = self._backup_root.joinpath(target_path)
+
+            backup_dir.mkdir(parents=True, exist_ok=True)
+            shutil.copy2(source_path, backup_dir.joinpath(filename))
+
+            Logger.print_ok(
+                f"Successfully backed up '{source_path}' to '{backup_dir}'"
+            )
+            return True
+
+        except Exception as e:
+            Logger.print_error(f"Failed to backup '{source_path}': {e}")
+            return False
+
+    def backup_directory(
+        self,
+        source_path: Path,
+        backup_name: str,
+        target_path: Optional[Path | str] = None,
+    ) -> Optional[Path]:
+        source_path = Path(source_path)
+
+        Logger.print_status(f"Creating backup of {source_path} ...")
+
+        if not source_path.exists():
+            Logger.print_info(
+                f"Directory '{source_path}' does not exist! Skipping backup..."
+            )
+            return None
+
+        if not source_path.is_dir():
+            Logger.print_info(f"'{source_path}' is not a directory! Skipping backup...")
+            return None
+
+        try:
+            self._backup_root.mkdir(parents=True, exist_ok=True)
+
+            backup_dir_name = f"{backup_name}_{self.timestamp}"
+
+            if target_path is not None:
+                backup_path = self._backup_root.joinpath(target_path, backup_dir_name)
+            else:
+                backup_path = self._backup_root.joinpath(backup_dir_name)
+
+            if backup_path.exists():
+                Logger.print_info(f"Reusing existing backup directory '{backup_path}'")
+
+            shutil.copytree(
+                source_path,
+                backup_path,
+                dirs_exist_ok=True,
+                symlinks=True,
+                ignore_dangling_symlinks=True,
+            )
+
+            Logger.print_ok(
+                f"Successfully backed up '{source_path}' to '{backup_path}'"
+            )
+            return backup_path
+
+        except Exception as e:
+            Logger.print_error(f"Failed to backup directory '{source_path}': {e}")
+            return None
+
+    ################################################
+    # SPECIFIC BACKUP METHODS
+    ################################################
+
+    def backup_printer_cfg(self):
+        klipper_instances: List[Klipper] = get_instances(Klipper)
+        for instance in klipper_instances:
+            target_path: Path = self._backup_root.joinpath(
+                instance.data_dir.name, f"config_{self.timestamp}"
+            )
+            self.backup_file(
+                source_path=instance.cfg_file,
+                target_path=target_path,
+                target_name=instance.cfg_file.name,
+            )
+
+    def backup_moonraker_conf(self):
+        moonraker_instances: List[Moonraker] = get_instances(Moonraker)
+        for instance in moonraker_instances:
+            target_path: Path = self._backup_root.joinpath(
+                instance.data_dir.name, f"config_{self.timestamp}"
+            )
+            self.backup_file(
+                source_path=instance.cfg_file,
+                target_path=target_path,
+                target_name=instance.cfg_file.name,
+            )
+
+    def backup_printer_config_dir(self) -> None:
+        instances: List[Klipper] = get_instances(Klipper)
+        if not instances:
+            # fallback: search for printer data directories in the user's home directory
+            Logger.print_info("No Klipper instances found via systemd services.")
+            Logger.print_info(
+                "Attempting to find printer data directories in home directory..."
+            )
+
+            home_dir = Path.home()
+            printer_data_dirs = []
+
+            for pattern in ["printer_data", "printer_*_data"]:
+                for data_dir in home_dir.glob(pattern):
+                    if data_dir.is_dir():
+                        printer_data_dirs.append(data_dir)
+
+            if not printer_data_dirs:
+                Logger.print_info("Unable to find directory to backup!")
+                Logger.print_info(
+                    "No printer data directories found in home directory."
+                )
+                return
+
+            for data_dir in printer_data_dirs:
+                self.backup_directory(
+                    source_path=data_dir.joinpath("config"),
+                    target_path=data_dir.name,
+                    backup_name="config",
+                )
+
+            return
+
+        for instance in instances:
+            self.backup_directory(
+                source_path=instance.base.cfg_dir,
+                target_path=f"{instance.data_dir.name}",
+                backup_name="config",
+            )

kiauh/core/services/message_service.py

@@ -0,0 +1,61 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import List
+
+from core.logger import DialogType, Logger
+from core.types.color import Color
+
+
+@dataclass()
+class Message:
+    title: str = field(default="")
+    text: List[str] = field(default_factory=list)
+    color: Color = field(default=Color.WHITE)
+    centered: bool = field(default=False)
+
+
+class MessageService:
+    __cls_instance = None
+    __message: Message | None
+
+    def __new__(cls) -> "MessageService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(MessageService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+        self.__message = None
+
+    def set_message(self, message: Message) -> None:
+        self.__message = message
+
+    def display_message(self) -> None:
+        if self.__message is None:
+            return
+
+        Logger.print_dialog(
+            title=DialogType.CUSTOM,
+            content=self.__message.text,
+            custom_title=self.__message.title,
+            custom_color=self.__message.color,
+            center_content=self.__message.centered,
+        )
+
+        self.__clear_message()
+
+    def __clear_message(self) -> None:
+        self.__message = None

kiauh/core/settings/kiauh_settings.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
@@ -8,15 +8,18 @@
 # ======================================================================= #
 from __future__ import annotations
 
+import shutil
 from dataclasses import dataclass, field
-from typing import Any
+from typing import Any, Callable, List, TypeVar
 
+from components.klipper import KLIPPER_REPO_URL
+from components.moonraker import MOONRAKER_REPO_URL
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-    NoOptionError,
-    NoSectionError,
     SimpleConfigParser,
 )
+from utils.input_utils import get_confirm
 from utils.sys_utils import kill
 
 from kiauh import PROJECT_ROOT
@@ -24,6 +27,16 @@ from kiauh import PROJECT_ROOT
 DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
 CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
 
+T = TypeVar("T")
+
+
+class InvalidValueError(Exception):
+    """Raised when a value is invalid for an option"""
+
+    def __init__(self, section: str, option: str, value: str):
+        msg = f"Invalid value '{value}' for option '{option}' in section '{section}'"
+        super().__init__(msg)
+
 
 @dataclass
 class AppSettings:
@@ -31,26 +44,40 @@ class AppSettings:
 
 
 @dataclass
-class RepoSettings:
-    repo_url: str | None = field(default=None)
-    branch: str | None = field(default=None)
+class Repository:
+    url: str
+    branch: str
+
+
+@dataclass
+class KlipperSettings:
+    repositories: List[Repository] | None = field(default=None)
+    use_python_binary: str | None = field(default=None)
+
+
+@dataclass
+class MoonrakerSettings:
+    optional_speedups: bool | None = field(default=None)
+    repositories: List[Repository] | None = field(default=None)
+    use_python_binary: str | None = field(default=None)
 
 
 @dataclass
 class WebUiSettings:
-    port: str | None = field(default=None)
+    port: int | None = field(default=None)
     unstable_releases: bool | None = field(default=None)
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KiauhSettings:
-    _instance = None
+    __instance = None
+    __initialized = False
 
     def __new__(cls, *args, **kwargs) -> "KiauhSettings":
-        if cls._instance is None:
-            cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
-        return cls._instance
+        if cls.__instance is None:
+            cls.__instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
+        return cls.__instance
 
     def __repr__(self) -> str:
         return (
@@ -63,20 +90,20 @@ class KiauhSettings:
         return getattr(self, item)
 
     def __init__(self) -> None:
-        if not hasattr(self, "__initialized"):
-            self.__initialized = False
         if self.__initialized:
             return
         self.__initialized = True
+
         self.config = SimpleConfigParser()
         self.kiauh = AppSettings()
-        self.klipper = RepoSettings()
-        self.moonraker = RepoSettings()
+        self.klipper = KlipperSettings()
+        self.moonraker = MoonrakerSettings()
         self.mainsail = WebUiSettings()
         self.fluidd = WebUiSettings()
 
-        self._load_config()
+        self.__read_config_set_internal_state()
 
+    # todo: refactor this, at least rename to something else!
     def get(self, section: str, option: str) -> str | int | bool:
         """
         Get a value from the settings state by providing the section and option name as
@@ -94,99 +121,11 @@ class KiauhSettings:
             raise
 
     def save(self) -> None:
-        self._set_config_options_state()
-        self.config.write_file(CUSTOM_CFG)
-        self._load_config()
+        self.__write_internal_state_to_cfg()
+        self.__read_config_set_internal_state()
 
-    def _load_config(self) -> None:
+    def __read_config_set_internal_state(self) -> None:
         if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
-            self._kill()
-
-        cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
-        self.config.read_file(cfg)
-
-        self._validate_cfg()
-        self._apply_settings_from_file()
-
-    def _validate_cfg(self) -> None:
-        try:
-            self._validate_bool("kiauh", "backup_before_update")
-
-            self._validate_str("klipper", "repo_url")
-            self._validate_str("klipper", "branch")
-
-            self._validate_int("mainsail", "port")
-            self._validate_bool("mainsail", "unstable_releases")
-
-            self._validate_int("fluidd", "port")
-            self._validate_bool("fluidd", "unstable_releases")
-
-        except ValueError:
-            err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
-            Logger.print_error(err)
-            kill()
-        except NoSectionError:
-            err = f"Missing section '{self._v_section}' in config file"
-            Logger.print_error(err)
-            kill()
-        except NoOptionError:
-            err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
-            Logger.print_error(err)
-            kill()
-
-    def _validate_bool(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        (bool(self.config.getboolean(section, option)))
-
-    def _validate_int(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        int(self.config.getint(section, option))
-
-    def _validate_str(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        v = self.config.getval(section, option)
-        if v.isdigit() or v.lower() == "true" or v.lower() == "false":
-            raise ValueError
-
-    def _apply_settings_from_file(self) -> None:
-        self.kiauh.backup_before_update = self.config.getboolean(
-            "kiauh", "backup_before_update"
-        )
-        self.klipper.repo_url = self.config.getval("klipper", "repo_url")
-        self.klipper.branch = self.config.getval("klipper", "branch")
-        self.moonraker.repo_url = self.config.getval("moonraker", "repo_url")
-        self.moonraker.branch = self.config.getval("moonraker", "branch")
-        self.mainsail.port = self.config.getint("mainsail", "port")
-        self.mainsail.unstable_releases = self.config.getboolean(
-            "mainsail", "unstable_releases"
-        )
-        self.fluidd.port = self.config.getint("fluidd", "port")
-        self.fluidd.unstable_releases = self.config.getboolean(
-            "fluidd", "unstable_releases"
-        )
-
-    def _set_config_options_state(self) -> None:
-        self.config.set_option(
-            "kiauh",
-            "backup_before_update",
-            str(self.kiauh.backup_before_update),
-        )
-        self.config.set_option("klipper", "repo_url", self.klipper.repo_url)
-        self.config.set_option("klipper", "branch", self.klipper.branch)
-        self.config.set_option("moonraker", "repo_url", self.moonraker.repo_url)
-        self.config.set_option("moonraker", "branch", self.moonraker.branch)
-        self.config.set_option("mainsail", "port", str(self.mainsail.port))
-        self.config.set_option(
-            "mainsail",
-            "unstable_releases",
-            str(self.mainsail.unstable_releases),
-        )
-        self.config.set_option("fluidd", "port", str(self.fluidd.port))
-        self.config.set_option(
-            "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
-        )
-
-    def _kill(self) -> None:
             Logger.print_dialog(
                 DialogType.ERROR,
                 [
@@ -197,3 +136,281 @@ class KiauhSettings:
                 ],
             )
             kill()
+
+        # copy default config to custom config if it does not exist
+        if not CUSTOM_CFG.exists():
+            shutil.copyfile(DEFAULT_CFG, CUSTOM_CFG)
+
+        self.config.read_file(CUSTOM_CFG)
+
+        # check if there are deprecated repo_url and branch options in the kiauh.cfg
+        if self._check_deprecated_repo_config():
+            self._prompt_migration_dialog()
+
+        self.__set_internal_state()
+
+    def __set_internal_state(self) -> None:
+        # parse Kiauh options
+        self.kiauh.backup_before_update = self.__read_from_cfg(
+            "kiauh",
+            "backup_before_update",
+            self.config.getboolean,
+            False,
+        )
+
+        # parse Klipper options
+        self.klipper.use_python_binary = self.__read_from_cfg(
+            "klipper",
+            "use_python_binary",
+            self.config.getval,
+            None,
+            True,
+        )
+        kl_repos: List[str] = self.__read_from_cfg(
+            "klipper",
+            "repositories",
+            self.config.getvals,
+            [KLIPPER_REPO_URL],
+        )
+        self.klipper.repositories = self.__set_repo_state("klipper", kl_repos)
+
+        # parse Moonraker options
+        self.moonraker.use_python_binary = self.__read_from_cfg(
+            "moonraker",
+            "use_python_binary",
+            self.config.getval,
+            None,
+            True,
+        )
+        self.moonraker.optional_speedups = self.__read_from_cfg(
+            "moonraker",
+            "optional_speedups",
+            self.config.getboolean,
+            True,
+        )
+        mr_repos: List[str] = self.__read_from_cfg(
+            "moonraker",
+            "repositories",
+            self.config.getvals,
+            [MOONRAKER_REPO_URL],
+        )
+        self.moonraker.repositories = self.__set_repo_state("moonraker", mr_repos)
+
+        # parse Mainsail options
+        self.mainsail.port = self.__read_from_cfg(
+            "mainsail",
+            "port",
+            self.config.getint,
+            80,
+        )
+        self.mainsail.unstable_releases = self.__read_from_cfg(
+            "mainsail",
+            "unstable_releases",
+            self.config.getboolean,
+            False,
+        )
+
+        # parse Fluidd options
+        self.fluidd.port = self.__read_from_cfg(
+            "fluidd",
+            "port",
+            self.config.getint,
+            80,
+        )
+        self.fluidd.unstable_releases = self.__read_from_cfg(
+            "fluidd",
+            "unstable_releases",
+            self.config.getboolean,
+            False,
+        )
+
+    def __check_option_exists(
+        self, section: str, option: str, fallback: Any, silent: bool = False
+    ) -> bool:
+        has_section = self.config.has_section(section)
+        has_option = self.config.has_option(section, option)
+
+        if not (has_section and has_option):
+            if not silent:
+                Logger.print_warn(
+                    f"Option '{option}' in section '{section}' not defined. Falling back to '{fallback}'."
+                )
+            return False
+        return True
+
+    def __read_bool_from_cfg(
+        self,
+        section: str,
+        option: str,
+        fallback: bool | None = None,
+        silent: bool = False,
+    ) -> bool | None:
+        if not self.__check_option_exists(section, option, fallback, silent):
+            return fallback
+        return self.config.getboolean(section, option, fallback)
+
+    def __read_from_cfg(
+        self,
+        section: str,
+        option: str,
+        getter: Callable[[str, str, T | None], T],
+        fallback: T | None = None,
+        silent: bool = False,
+    ) -> T | None:
+        if not self.__check_option_exists(section, option, fallback, silent):
+            return fallback
+        return getter(section, option, fallback)
+
+    def __set_repo_state(self, section: str, repos: List[str]) -> List[Repository]:
+        _repos: List[Repository] = []
+        for raw in repos:
+            line = raw.strip()
+
+            if not line or line.startswith("#") or line.startswith(";"):
+                continue
+
+            try:
+                if "," in line:
+                    url_part, branch_part = line.split(",")
+                    url = url_part.strip()
+                    branch = branch_part.strip() or "master"
+                else:
+                    url = line
+                    branch = "master"
+
+                # url must not be empty otherwise it's considered
+                # as an unrecoverable, invalid configuration
+                if not url:
+                    raise InvalidValueError(section, "repositories", line)
+
+                _repos.append(Repository(url.strip(), branch.strip()))
+
+            except InvalidValueError as e:
+                Logger.print_error(f"Error parsing kiauh.cfg: {e}")
+                kill()
+
+        return _repos
+
+    def __write_internal_state_to_cfg(self) -> None:
+        """Updates the config with current settings, preserving values that haven't been modified"""
+        if self.kiauh.backup_before_update is not None:
+            self.config.set_option(
+                "kiauh",
+                "backup_before_update",
+                str(self.kiauh.backup_before_update),
+            )
+
+        # Handle repositories
+        if self.klipper.repositories is not None:
+            repos = [f"{repo.url}, {repo.branch}" for repo in self.klipper.repositories]
+            self.config.set_option("klipper", "repositories", repos)
+
+        if self.moonraker.repositories is not None:
+            repos = [
+                f"{repo.url}, {repo.branch}" for repo in self.moonraker.repositories
+            ]
+            self.config.set_option("moonraker", "repositories", repos)
+
+        # Handle Mainsail settings
+        if self.mainsail.port is not None:
+            self.config.set_option("mainsail", "port", str(self.mainsail.port))
+        if self.mainsail.unstable_releases is not None:
+            self.config.set_option(
+                "mainsail",
+                "unstable_releases",
+                str(self.mainsail.unstable_releases),
+            )
+
+        # Handle Fluidd settings
+        if self.fluidd.port is not None:
+            self.config.set_option("fluidd", "port", str(self.fluidd.port))
+        if self.fluidd.unstable_releases is not None:
+            self.config.set_option(
+                "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
+            )
+
+        self.config.write_file(CUSTOM_CFG)
+
+    def _check_deprecated_repo_config(self) -> bool:
+        # repo_url and branch are deprecated - 2025.03.23
+        for section in ["klipper", "moonraker"]:
+            if self.config.has_option(section, "repo_url") or self.config.has_option(
+                section, "branch"
+            ):
+                return True
+        return False
+
+    def _prompt_migration_dialog(self) -> None:
+        migration_1: List[str] = [
+            "Options 'repo_url' and 'branch' are now combined into a 'repositories' option.",
+            "\n\n",
+            "● Old format:",
+            "  [klipper]",
+            "  repo_url: https://github.com/Klipper3d/klipper",
+            "  branch: master",
+            "\n\n",
+            "● New format:",
+            "  [klipper]",
+            "  repositories:",
+            "      https://github.com/Klipper3d/klipper, master",
+        ]
+        Logger.print_dialog(
+            DialogType.ATTENTION,
+            [
+                "Deprecated kiauh.cfg configuration found!",
+                "KAIUH can now attempt to automatically migrate the configuration.",
+                "\n\n",
+                *migration_1,
+            ],
+        )
+        if get_confirm("Migrate to the new format?"):
+            self._migrate_repo_config()
+        else:
+            Logger.print_dialog(
+                DialogType.ERROR,
+                [
+                    "Please update the configuration file manually.",
+                ],
+                center_content=True,
+            )
+            kill()
+
+    def _migrate_repo_config(self) -> None:
+        svc = BackupService()
+        if not svc.backup_file(CUSTOM_CFG):
+            Logger.print_dialog(
+                DialogType.ERROR,
+                [
+                    "Failed to create backup of kiauh.cfg. Aborting migration. Please migrate manually."
+                ],
+            )
+            kill()
+
+        # run migrations
+        try:
+            # migrate deprecated repo_url and branch options - 2025.03.23
+            for section in ["klipper", "moonraker"]:
+                if not self.config.has_section(section):
+                    continue
+
+                repo_url = self.config.getval(section, "repo_url", fallback="")
+                branch = self.config.getval(section, "branch", fallback="master")
+
+                if repo_url:
+                    # create repositories option with the old values
+                    repositories = [f"{repo_url}, {branch}\n"]
+                    self.config.set_option(section, "repositories", repositories)
+
+                    # remove deprecated options
+                    self.config.remove_option(section, "repo_url")
+                    self.config.remove_option(section, "branch")
+
+                    Logger.print_ok(f"Successfully migrated {section} configuration")
+
+            self.config.write_file(CUSTOM_CFG)
+            self.config.read_file(CUSTOM_CFG)  # reload config
+
+        except Exception as e:
+            Logger.print_error(f"Error migrating configuration: {e}")
+            Logger.print_error("Please migrate manually.")
+            kill()

kiauh/core/spinner.py

@@ -3,13 +3,7 @@ import threading
 import time
 from typing import List, Literal
 
-from core.constants import (
-    COLOR_GREEN,
-    COLOR_RED,
-    COLOR_WHITE,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
+from core.types.color import Color
 
 SpinnerColor = Literal["white", "red", "green", "yellow"]
 
@@ -18,21 +12,18 @@ class Spinner:
     def __init__(
         self,
         message: str = "Loading",
-        color: SpinnerColor = "white",
         interval: float = 0.2,
     ) -> None:
         self.message = f"{message} ..."
         self.interval = interval
         self._stop_event = threading.Event()
         self._thread = threading.Thread(target=self._animate)
-        self._color = ""
-        self._set_color(color)
 
     def _animate(self) -> None:
         animation: List[str] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
         while not self._stop_event.is_set():
             for char in animation:
-                sys.stdout.write(f"\r{self._color}{char}{RESET_FORMAT} {self.message}")
+                sys.stdout.write(f"\r{Color.GREEN}{char}{Color.RST} {self.message}")
                 sys.stdout.flush()
                 time.sleep(self.interval)
                 if self._stop_event.is_set():
@@ -40,16 +31,6 @@ class Spinner:
         sys.stdout.write("\r" + " " * (len(self.message) + 1) + "\r")
         sys.stdout.flush()
 
-    def _set_color(self, color: SpinnerColor) -> None:
-        if color == "white":
-            self._color = COLOR_WHITE
-        elif color == "red":
-            self._color = COLOR_RED
-        elif color == "green":
-            self._color = COLOR_GREEN
-        elif color == "yellow":
-            self._color = COLOR_YELLOW
-
     def start(self) -> None:
         self._stop_event.clear()
         if not self._thread.is_alive():

kiauh/core/submodules/simple_config_parser/README.md

@@ -3,4 +3,17 @@
 A custom config parser inspired by Python's configparser module.
 Specialized for handling Klipper style config files.
 
+---
+
+### When parsing a config file, it will be split into the following elements:
+- Header: All lines before the first section
+- Section: A section is defined by a line starting with a `[` and ending with a `]`
+- Option: A line starting with a word, followed by a `:` or `=` and a value
+- Option Block: A line starting with a word, followed by a `:` or `=` and a newline
+  - The word `gcode` is excluded from being treated as an option block
+- Gcode Block: A line starting with the word `gcode`, followed by a `:` or `=` and a newline
+  - All indented lines following the gcode line are considered part of the gcode block
+- Comment: A line starting with a `#` or `;`
+- Blank: A line containing only whitespace characters
+- SaveConfig Block: Klippers auto-generated SAVE_CONFIG section that can be found at the very end of the config file
 

kiauh/core/submodules/simple_config_parser/pyproject.toml

@@ -36,7 +36,7 @@ extend-select = ["I"]
 [tool.pytest.ini_options]
 minversion = "8.2.1"
 testpaths = ["tests/**/*.py"]
-addopts = "--cov --cov-config=pyproject.toml --cov-report=html"
+addopts = "-svvv --cov --cov-config=pyproject.toml --cov-report=html"
 
 [tool.coverage.run]
 branch = true

kiauh/core/submodules/simple_config_parser/src/simple_config_parser/constants.py

@@ -1,62 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
-#                                                                         #
-#  https://github.com/dw-0/simple-config-parser                           #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import re
-
-# definition of section line:
-#  - then line MUST start with an opening square bracket - it is the first section marker
-#  - the section marker MUST be followed by at least one character - it is the section name
-#  - the section name MUST be followed by a closing square bracket - it is the second section marker
-#  - the second section marker MAY be followed by any amount of whitespace characters
-#  - the second section marker MAY be followed by a # or ; - it is the comment marker
-#  - the inline comment MAY be of any length and character
-SECTION_RE = re.compile(r"^\[(\S.*\S|\S)]\s*([#;].*)?$")
-
-# definition of option line:
-#  - the line MUST start with a word - it is the option name
-#  - the option name MUST be followed by a colon or an equal sign - it is the separator
-#  - the separator MUST be followed by a value
-#    - the separator MAY have any amount of leading or trailing whitespaces
-#    - the separator MUST NOT be directly followed by a colon or equal sign
-#  - the value MAY be of any length and character
-#    - the value MAY contain any amount of trailing whitespaces
-#    - the value MAY be followed by a # or ; - it is the comment marker
-#  - the inline comment MAY be of any length and character
-OPTION_RE = re.compile(r"^([^;#:=\s]+)\s?[:=]\s*([^;#:=\s][^;#]*?)\s*([#;].*)?$")
-# definition of options block start line:
-#  - the line MUST start with a word - it is the option name
-#  - the option name MUST be followed by a colon or an equal sign - it is the separator
-#  - the separator MUST NOT be followed by a value
-#    - the separator MAY have any amount of leading or trailing whitespaces
-#    - the separator MUST NOT be directly followed by a colon or equal sign
-#    - the separator MAY be followed by a # or ; - it is the comment marker
-#  - the inline comment MAY be of any length and character
-OPTIONS_BLOCK_START_RE = re.compile(r"^([^;#:=\s]+)\s*[:=]\s*([#;].*)?$")
-
-# definition of comment line:
-#  - the line MAY start with any amount of whitespace characters
-#  - the line MUST contain a # or ; - it is the comment marker
-#  - the comment marker MAY be followed by any amount of whitespace characters
-#  - the comment MAY be of any length and character
-LINE_COMMENT_RE = re.compile(r"^\s*[#;].*")
-
-# definition of empty line:
-#  - the line MUST contain only whitespace characters
-EMPTY_LINE_RE = re.compile(r"^\s*$")
-
-BOOLEAN_STATES = {
-    "1": True,
-    "yes": True,
-    "true": True,
-    "on": True,
-    "0": False,
-    "no": False,
-    "false": False,
-    "off": False,
-}
-
-HEADER_IDENT = "#_header"

kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
+#  Copyright (C) 2025 Dominik Willner <th33xitus@gmail.com>               #
 #                                                                         #
 #  https://github.com/dw-0/simple-config-parser                           #
 #                                                                         #
@@ -8,21 +8,89 @@
 
 from __future__ import annotations
 
-import secrets
-import string
+import re
+from dataclasses import dataclass, field
+from enum import Enum
 from pathlib import Path
-from typing import Callable, Dict, List
+from typing import Any, Callable, Dict, List, Set, Union
 
-from ..simple_config_parser.constants import (
-    BOOLEAN_STATES,
-    EMPTY_LINE_RE,
-    HEADER_IDENT,
-    LINE_COMMENT_RE,
-    OPTION_RE,
-    OPTIONS_BLOCK_START_RE,
-    SECTION_RE,
+# definition of section line:
+#  - the line MUST start with an opening square bracket - it is the first section marker
+#  - the section marker MUST be followed by at least one character - it is the section name
+#  - the section name MUST be followed by a closing square bracket - it is the second section marker
+#  - the second section marker MAY be followed by any amount of whitespace characters
+#  - the second section marker MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+SECTION_RE = re.compile(r"^\[(\S.*\S|\S)]\s*([#;].*)?$")
+
+# definition of option line:
+#  - the line MUST start with a word - it is the option name
+#  - the option name MUST be followed by a colon or an equal sign - it is the separator
+#  - the separator MUST be followed by a value
+#    - the separator MAY have any amount of leading or trailing whitespaces
+#    - the separator MUST NOT be directly followed by a colon or equal sign
+#  - the value MAY be of any length and character
+#    - the value MAY contain any amount of trailing whitespaces
+#    - the value MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+OPTION_RE = re.compile(r"^([^;#:=\s]+)\s?[:=]\s*([^;#:=\s][^;#]*?)\s*([#;].*)?$")
+
+# definition of options block start line:
+#  - the line MUST start with a word - it is the option name
+#  - the option name MUST NOT be "gcode"
+#  - the option name MUST be followed by a colon or an equal sign - it is the separator
+#  - the separator MUST NOT be followed by a value
+#    - the separator MAY have any amount of leading or trailing whitespaces
+#    - the separator MUST NOT be directly followed by a colon or equal sign
+#    - the separator MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+OPTIONS_BLOCK_START_RE = re.compile(
+    r"^(?!\s*gcode\s*[:=])([^;#:=\s]+)\s*[:=]\s*([#;].*)?$"
 )
 
+# definition of gcode block start line:
+#  - the line MUST start with the word "gcode"
+#  - the word "gcode" MUST be followed by a colon or an equal sign - it is the separator
+#  - the separator MUST NOT be followed by a value
+#    - the separator MAY have any amount of leading or trailing whitespaces
+#    - the separator MUST NOT be directly followed by a colon or equal sign
+#    - the separator MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+GCODE_BLOCK_START_RE = re.compile(r"^\s*gcode\s*[:=]\s*(?:[#;].*)?$")
+
+# definition of comment line:
+#  - the line MAY start with any amount of whitespace characters
+#  - the line MUST contain a # or ; - it is the comment marker
+#  - the comment marker MAY be followed by any amount of whitespace characters
+#  - the comment MAY be of any length and character
+LINE_COMMENT_RE = re.compile(r"^\s*[#;].*")
+
+# definition of empty line:
+#  - the line MUST contain only whitespace characters
+EMPTY_LINE_RE = re.compile(r"^\s*$")
+
+SAVE_CONFIG_START_RE = re.compile(r"^#\*# <-+ SAVE_CONFIG -+>$")
+SAVE_CONFIG_CONTENT_RE = re.compile(r"^#\*#.*$")
+
+BOOLEAN_STATES = {
+    "1": True,
+    "yes": True,
+    "true": True,
+    "on": True,
+    "0": False,
+    "no": False,
+    "false": False,
+    "off": False,
+}
+
+
+class LineType(Enum):
+    OPTION = "option"
+    OPTION_BLOCK = "option_block"
+    COMMENT = "comment"
+    BLANK = "blank"
+
+
 _UNSET = object()
 
 
@@ -50,32 +118,116 @@ class NoOptionError(Exception):
         super().__init__(msg)
 
 
+class UnknownLineError(Exception):
+    """Raised when a line is not recognized as any known type"""
+
+    def __init__(self, line: str):
+        msg = f"Unknown line: '{line}'"
+        super().__init__(msg)
+
+
+@dataclass
+class Option:
+    """Dataclass representing a (pseudo) config option"""
+
+    name: str
+    raw: str
+    value: str
+
+
+@dataclass
+class MultiLineOption:
+    """Dataclass representing a multi-line config option"""
+
+    name: str
+    raw: str
+    values: List[MLOptionValue] = field(default_factory=list)
+
+
+@dataclass
+class MLOptionValue:
+    """Dataclass representing a value in a multi-line option"""
+
+    raw: str
+    indent: int
+    value: str
+
+
+@dataclass
+class Gcode:
+    """Dataclass representing a gcode block"""
+
+    name: str
+    raw: str
+    gcode: List[str] = field(default_factory=list)
+
+
+@dataclass
+class BlankLine:
+    """Dataclass representing a blank line"""
+
+    raw: str = "\n"
+
+
+@dataclass
+class CommentLine:
+    """Dataclass representing a comment line"""
+
+    raw: str
+
+
+SectionItem = Union[Option, MultiLineOption, Gcode, BlankLine, CommentLine]
+
+
+@dataclass
+class Section:
+    """Dataclass representing a config section"""
+
+    name: str
+    raw: str
+    items: List[SectionItem] = field(default_factory=list)
+
+
 # noinspection PyMethodMayBeStatic
 class SimpleConfigParser:
     """A customized config parser targeted at handling Klipper style config files"""
 
     def __init__(self) -> None:
-        self.header: List[str] = []
         self.config: Dict = {}
-        self.current_section: str | None = None
-        self.current_opt_block: str | None = None
-        self.current_collector: str | None = None
-        self.in_option_block: bool = False
+
+        self._header: List[str] = []
+        self._save_config_block: List[str] = []
+        self._config: List[Section] = []
+        self._curr_sect: Union[Section, None] = None
+        self._curr_ml_opt: Union[MultiLineOption, None] = None
+        self._curr_gcode: Union[Gcode, None] = None
 
     def _match_section(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of a section"""
+        """Whether the given line matches the definition of a section"""
         return SECTION_RE.match(line) is not None
 
     def _match_option(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of an option"""
+        """Whether the given line matches the definition of an option"""
         return OPTION_RE.match(line) is not None
 
     def _match_options_block_start(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of a multiline option"""
+        """Whether the given line matches the definition of a multiline option"""
         return OPTIONS_BLOCK_START_RE.match(line) is not None
 
+    def _match_gcode_block_start(self, line: str) -> bool:
+        """Whether the given line matches the definition of a gcode block start"""
+        return GCODE_BLOCK_START_RE.match(line) is not None
+
+    def _match_save_config_start(self, line: str) -> bool:
+        """Whether the given line matches the definition of a save config start"""
+        return SAVE_CONFIG_START_RE.match(line) is not None
+
+    def _match_save_config_content(self, line: str) -> bool:
+        """Whether the given line matches the definition of a save config content"""
+        return SAVE_CONFIG_CONTENT_RE.match(line) is not None
+
     def _match_line_comment(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of a comment"""
+        """Whether the given line matches the definition of a comment"""
         return LINE_COMMENT_RE.match(line) is not None
 
     def _match_empty_line(self, line: str) -> bool:
@@ -84,134 +236,186 @@ class SimpleConfigParser:
 
     def _parse_line(self, line: str) -> None:
         """Parses a line and determines its type"""
+        if self._curr_sect is None and not self._match_section(line):
+            # we are at the beginning of the file, so we consider the part
+            # up to the first section as the file header and store it separately
+            self._header.append(line)
+            return
+
         if self._match_section(line):
-            self.current_collector = None
-            self.current_opt_block = None
-            self.current_section = SECTION_RE.match(line).group(1)
-            self.config[self.current_section] = {"_raw": line}
+            self._reset_special_items()
 
-        elif self._match_option(line):
-            self.current_collector = None
-            self.current_opt_block = None
-            option = OPTION_RE.match(line).group(1)
-            value = OPTION_RE.match(line).group(2)
-            self.config[self.current_section][option] = {"_raw": line, "value": value}
+            sect_name: str = SECTION_RE.match(line).group(1)
+            sect = Section(name=sect_name, raw=line)
+            self._curr_sect = sect
+            self._config.append(sect)
+            return
 
-        elif self._match_options_block_start(line):
-            self.current_collector = None
-            option = OPTIONS_BLOCK_START_RE.match(line).group(1)
-            self.current_opt_block = option
-            self.config[self.current_section][option] = {"_raw": line, "value": []}
+        if self._match_option(line):
+            self._reset_special_items()
 
-        elif self.current_opt_block is not None:
-            self.config[self.current_section][self.current_opt_block]["value"].append(
-                line
+            name: str = OPTION_RE.match(line).group(1)
+            val: str = OPTION_RE.match(line).group(2)
+            opt = Option(
+                name=name,
+                raw=line,
+                value=val,
             )
+            self._curr_sect.items.append(opt)
+            return
 
-        elif self._match_empty_line(line) or self._match_line_comment(line):
-            self.current_opt_block = None
+        if self._match_options_block_start(line):
+            self._reset_special_items()
 
-            # if current_section is None, we are at the beginning of the file,
-            # so we consider the part up to the first section as the file header
-            if not self.current_section:
-                self.config.setdefault(HEADER_IDENT, []).append(line)
+            name: str = OPTIONS_BLOCK_START_RE.match(line).group(1)
+            ml_opt = MultiLineOption(
+                name=name,
+                raw=line,
+            )
+            self._curr_ml_opt = ml_opt
+            self._curr_sect.items.append(ml_opt)
+            return
+
+        if self._curr_ml_opt is not None:
+            # we are in an option block, so we consecutively add values
+            # to the current multiline option until we hit a different line type
+
+            if "#" in line:
+                value = line.split("#", 1)[0].strip()
+            elif ";" in line:
+                value = line.split(";", 1)[0].strip()
             else:
-                section = self.config[self.current_section]
+                value = line.strip()
 
-                # set the current collector to a new value, so that continuous
-                # empty lines or comments are collected into the same collector
-                if not self.current_collector:
-                    self.current_collector = self._generate_rand_id()
-                    section[self.current_collector] = []
+            ml_value = MLOptionValue(
+                raw=line,
+                indent=self._get_indent(line),
+                value=value,
+            )
+            self._curr_ml_opt.values.append(ml_value)
+            return
 
-                section[self.current_collector].append(line)
+        if self._match_gcode_block_start(line):
+            self._curr_gcode = Gcode(
+                name="gcode",
+                raw=line,
+            )
+            self._curr_sect.items.append(self._curr_gcode)
+            return
+
+        if self._curr_gcode is not None:
+            # we are in a gcode block, so we add any following line
+            # without further checks to the gcode block
+            self._curr_gcode.gcode.append(line)
+            return
+
+        if self._match_save_config_start(line):
+            self._reset_special_items()
+            self._save_config_block.append(line)
+            return
+
+        if self._match_save_config_content(line):
+            self._reset_special_items()
+            self._save_config_block.append(line)
+            return
+
+        if self._match_empty_line(line):
+            self._reset_special_items()
+            self._curr_sect.items.append(BlankLine(raw=line))
+            return
+
+        if self._match_line_comment(line):
+            self._reset_special_items()
+            self._curr_sect.items.append(CommentLine(raw=line))
+            return
+
+    def _reset_special_items(self) -> None:
+        """Reset special items like current multine option and gcode block"""
+        self._curr_ml_opt = None
+        self._curr_gcode = None
+
+    def _get_indent(self, line: str) -> int:
+        """Return the indentation level of a line"""
+        return len(line) - len(line.lstrip())
 
     def read_file(self, file: Path) -> None:
         """Read and parse a config file"""
-        with open(file, "r") as file:
+        self._config = []
+        with open(file, "r", encoding="utf-8") as file:
             for line in file:
                 self._parse_line(line)
 
-        # print(json.dumps(self.config, indent=4))
+    def write_file(self, path: str | Path) -> None:
+        """Write the config to a file"""
+        if path is None:
+            raise ValueError("File path cannot be None")
 
-    def write_file(self, file: Path) -> None:
-        """Write the current config to the config file"""
-        if not file:
-            raise ValueError("No config file specified")
+        # first write the header
+        content: List[str] = list(self._header)
 
-        with open(file, "w") as file:
-            self._write_header(file)
-            self._write_sections(file)
+        # then write all sections
+        for i in self._config:
+            content.append(i.raw)
+            for item in i.items:
+                content.append(item.raw)
+                if isinstance(item, MultiLineOption):
+                    content.extend(val.raw for val in item.values)
+                elif isinstance(item, Gcode):
+                    content.extend(item.gcode)
 
-    def _write_header(self, file) -> None:
-        """Write the header to the config file"""
-        for line in self.config.get(HEADER_IDENT, []):
-            file.write(line)
+        # then write the save config block
+        content.extend(self._save_config_block)
 
-    def _write_sections(self, file) -> None:
-        """Write the sections to the config file"""
-        for section in self.get_sections():
-            for key, value in self.config[section].items():
-                self._write_section_content(file, key, value)
+        # ensure file ends with a newline
+        if content and not content[-1].endswith("\n"):
+            content.append("\n")
 
-    def _write_section_content(self, file, key, value) -> None:
-        """Write the content of a section to the config file"""
-        if key == "_raw":
-            file.write(value)
-        elif key.startswith("#_"):
-            for line in value:
-                file.write(line)
-        elif isinstance(value["value"], list):
-            file.write(value["_raw"])
-            for line in value["value"]:
-                file.write(line)
-        else:
-            file.write(value["_raw"])
+        with open(path, "w", encoding="utf-8", newline="\n") as f:
+            f.writelines(content)
 
-    def get_sections(self) -> List[str]:
-        """Return a list of all section names, but exclude any section starting with '#_'"""
-        return list(
-            filter(
-                lambda section: not section.startswith("#_"),
-                self.config.keys(),
-            )
-        )
+    def get_sections(self) -> Set[str]:
+        """Return a set of all section names"""
+        return {s.name for s in self._config} if self._config else set()
 
     def has_section(self, section: str) -> bool:
         """Check if a section exists"""
         return section in self.get_sections()
 
-    def add_section(self, section: str) -> None:
+    def add_section(self, section: str) -> Section:
         """Add a new section to the config"""
         if section in self.get_sections():
             raise DuplicateSectionError(section)
 
-        if len(self.get_sections()) >= 1:
-            self._check_set_section_spacing()
+        if not self._config:
+            new_sect = Section(name=section, raw=f"[{section}]\n")
+            self._config.append(new_sect)
+            return new_sect
 
-        self.config[section] = {"_raw": f"[{section}]\n"}
+        last_sect: Section = self._config[-1]
+        if not last_sect.items or (
+            last_sect.items and not isinstance(last_sect.items[-1], BlankLine)
+        ):
+            last_sect.items.append(BlankLine())
 
-    def _check_set_section_spacing(self):
-        prev_section = self.get_sections()[-1]
-        prev_section_content = self.config[prev_section]
-        last_item = list(prev_section_content.keys())[-1]
-        if last_item.startswith("#_") and last_item.keys()[-1] != "\n":
-            prev_section_content[last_item].append("\n")
-        else:
-            prev_section_content[self._generate_rand_id()] = ["\n"]
+        new_sect = Section(name=section, raw=f"[{section}]\n")
+        self._config.append(new_sect)
+        return new_sect
 
     def remove_section(self, section: str) -> None:
-        """Remove a section from the config"""
-        self.config.pop(section, None)
+        """Remove a section from the config
 
-    def get_options(self, section: str) -> List[str]:
-        """Return a list of all option names for a given section"""
-        return list(
-            filter(
-                lambda option: option != "_raw" and not option.startswith("#_"),
-                self.config[section].keys(),
-            )
-        )
+        This will remove ALL occurences of sections with the given name.
+        """
+        self._config = [s for s in self._config if s.name != section]
+
+    def get_options(self, section: str) -> Set[str]:
+        """Return a set of all option names for a given section"""
+        sections: List[Section] = [s for s in self._config if s.name == section]
+        all_items: List[SectionItem] = [
+            item for section in sections for item in section.items
+        ]
+
+        return {o.name for o in all_items if isinstance(o, (Option, MultiLineOption))}
 
     def has_option(self, section: str, option: str) -> bool:
         """Check if an option exists in a section"""
@@ -222,29 +426,143 @@ class SimpleConfigParser:
         Set the value of an option in a section. If the section does not exist,
         it is created. If the option does not exist, it is created.
         """
-        if not self.has_section(section):
-            self.add_section(section)
 
-        if not self.has_option(section, option):
-            self.config[section][option] = {
-                "_raw": f"{option}:\n"
-                if isinstance(value, list)
-                else f"{option}: {value}\n",
-                "value": value,
-            }
+        # when adding options, we add them to the first matching section
+        # if the section does not exist, we create it
+        section: Section = (
+            self.add_section(section)
+            if not self.has_section(section)
+            else next(s for s in self._config if s.name == section)
+        )
+
+        opt = self._find_option_by_name(option, section=section)
+        if opt is None:
+            if isinstance(value, list):
+                indent = 4
+                _opt = MultiLineOption(
+                    name=option,
+                    raw=f"{option}:\n",
+                    values=[
+                        MLOptionValue(
+                            raw=f"{' ' * indent}{val}\n",
+                            indent=indent,
+                            value=val,
+                        )
+                        for val in value
+                    ],
+                )
             else:
-            opt = self.config[section][option]
-            if not isinstance(value, list):
-                opt["_raw"] = opt["_raw"].replace(opt["value"], value)
-            opt["value"] = value
+                _opt = Option(
+                    name=option,
+                    raw=f"{option}: {value}\n",
+                    value=value,
+                )
+
+            last_opt_idx: int = 0
+            for idx, item in enumerate(section.items):
+                if isinstance(item, (Option, MultiLineOption)):
+                    last_opt_idx = idx
+            # insert the new option after the last existing option
+            section.items.insert(last_opt_idx + 1, _opt)
+
+        elif opt and isinstance(opt, Option) and isinstance(value, str):
+            curr_val = opt.value
+            new_val = value
+            opt.value = new_val
+            opt.raw = opt.raw.replace(curr_val, new_val)
+
+        elif opt and isinstance(opt, MultiLineOption) and isinstance(value, list):
+            # note: we completely replace the existing values
+            # so any existing indentation, comments, etc. will be lost
+            indent = 4
+            opt.values = [
+                MLOptionValue(
+                    raw=f"{' ' * indent}{val}\n",
+                    indent=indent,
+                    value=val,
+                )
+                for val in value
+            ]
+
+    def _find_section_by_name(
+        self, sect_name: str
+    ) -> Union[None, Section, List[Section]]:
+        """Find a section by name"""
+        _sects = [s for s in self._config if s.name == sect_name]
+        if len(_sects) > 1:
+            return _sects
+        elif len(_sects) == 1:
+            return _sects[0]
+        else:
+            return None
+
+    def _find_option_by_name(
+        self,
+        opt_name: str,
+        section: Union[Section, None] = None,
+        sections: Union[List[Section], None] = None,
+    ) -> Union[None, Option, MultiLineOption]:
+        """Find an option or multi-line option by name in a section"""
+
+        # if a single section is provided, search its items for the option
+        if section is not None:
+            for item in section.items:
+                if (
+                    isinstance(item, (Option, MultiLineOption))
+                    and item.name == opt_name
+                ):
+                    return item
+
+        # if multiple sections with the same name are provided, merge their
+        # items and search for the option
+        if sections is not None:
+            all_items: List[SectionItem] = [
+                item for sect in sections for item in sect.items
+            ]
+            for item in all_items:
+                if (
+                    isinstance(item, (Option, MultiLineOption))
+                    and item.name == opt_name
+                ):
+                    return item
+
+        return None
 
     def remove_option(self, section: str, option: str) -> None:
-        """Remove an option from a section"""
-        self.config[section].pop(option, None)
+        """Remove an option from a section
 
-    def getval(
-        self, section: str, option: str, fallback: str | _UNSET = _UNSET
-    ) -> str | List[str]:
+        This will remove the option from ALL occurences of sections with the given name.
+        Other non-option items (comments, blank lines, etc.) are preserved.
+        """
+        sections: List[Section] = [s for s in self._config if s.name == section]
+        if not sections:
+            return
+
+        for sect in sections:
+            sect.items = [
+                item
+                for item in sect.items
+                if not (
+                    isinstance(item, (Option, MultiLineOption)) and item.name == option
+                )
+            ]
+
+    def _get_option(
+        self, section: str, option: str
+    ) -> Union[Option, MultiLineOption, None]:
+        """Internal helper to resolve an option or multi-line option."""
+        if section not in self.get_sections():
+            raise NoSectionError(section)
+        if option not in self.get_options(section):
+            raise NoOptionError(option, section)
+        sects: List[Section] = [s for s in self._config if s.name == section]
+        return (
+            self._find_option_by_name(option, sections=sects)
+            if len(sects) > 1
+            else self._find_option_by_name(option, section=sects[0])
+        )
+
+    def getval(self, section: str, option: str, fallback: str | _UNSET = _UNSET) -> str:
         """
         Return the value of the given option in the given section
 
@@ -252,11 +570,33 @@ class SimpleConfigParser:
         a fallback value.
         """
         try:
-            if section not in self.get_sections():
-                raise NoSectionError(section)
-            if option not in self.get_options(section):
+            opt = self._get_option(section, option)
+            if not isinstance(opt, Option):
                 raise NoOptionError(option, section)
-            return self.config[section][option]["value"]
+
+            return opt.value if opt else ""
+
+        except (NoSectionError, NoOptionError):
+            if fallback is _UNSET:
+                raise
+            return fallback
+
+    def getvals(
+        self, section: str, option: str, fallback: List[str] | _UNSET = _UNSET
+    ) -> List[str]:
+        """
+        Return the values of the given multi-line option in the given section
+
+        If the key is not found and 'fallback' is provided, it is used as
+        a fallback value.
+        """
+        try:
+            opt = self._get_option(section, option)
+            if not isinstance(opt, MultiLineOption):
+                raise NoOptionError(option, section)
+
+            return [v.value for v in opt.values] if opt else []
+
         except (NoSectionError, NoOptionError):
             if fallback is _UNSET:
                 raise
@@ -293,20 +633,14 @@ class SimpleConfigParser:
         section: str,
         option: str,
         conv: Callable[[str], int | float | bool],
-        fallback: _UNSET = _UNSET,
+        fallback: Any = _UNSET,
     ) -> int | float | bool:
         """Return the value of the given option in the given section as a converted value"""
         try:
             return conv(self.getval(section, option, fallback))
-        except ValueError as e:
+        except (ValueError, TypeError, AttributeError) as e:
             if fallback is not _UNSET:
                 return fallback
             raise ValueError(
                 f"Cannot convert {self.getval(section, option)} to {conv.__name__}"
             ) from e
-
-    def _generate_rand_id(self) -> str:
-        """Generate a random id with 6 characters"""
-        chars = string.ascii_letters + string.digits
-        rand_string = "".join(secrets.choice(chars) for _ in range(12))
-        return f"#_{rand_string}"

kiauh/core/submodules/simple_config_parser/tests/assets/test_config_2.cfg

@@ -0,0 +1,33 @@
+# a comment at the very top
+# should be treated as the file header
+
+# up to the first section, including all blank lines
+
+[section_1]
+option_1: value_1
+option_1_1: True # this is a boolean
+option_1_2: 5 ; this is an integer
+option_1_3: 1.123 #;this is a float
+
+[section_2] ; comment
+option_2: value_2
+
+; comment
+
+[section_3]
+option_3: value_3 # comment
+
+[section_4]
+# comment
+option_4: value_4
+
+[section number 5]
+#option_5: value_5
+option_5 = this.is.value-5
+multi_option:
+    # these are multi-line values
+    value_5_1
+    value_5_2 ; here is a comment
+    value_5_3
+option_5_1: value_5_1
+# config ending with a comment

kiauh/core/submodules/simple_config_parser/tests/assets/test_config_3.cfg

@@ -0,0 +1,94 @@
+# a comment at the very top
+# should be treated as the file header
+
+# up to the first section, including all blank lines
+
+[section_1]
+option_1: value_1
+option_1_1: True # this is a boolean
+option_1_2: 5 ; this is an integer
+option_1_3: 1.123 #;this is a float
+
+[section_2] ; comment
+option_2: value_2
+
+; comment
+
+[section_3]
+option_3: value_3 # comment
+
+[section_4]
+# comment
+option_4: value_4
+
+[section number 5]
+#option_5: value_5
+option_5 = this.is.value-5
+multi_option:
+    # these are multi-line values
+    value_5_1
+    value_5_2 ; here is a comment
+    value_5_3
+option_5_1: value_5_1
+
+[gcode_macro M117]
+rename_existing: M117.1
+gcode:
+    {% if rawparams %}
+       {% set escaped_msg = rawparams.split(';', 1)[0].split('\x23', 1)[0]|replace('"', '\\"') %}
+       SET_DISPLAY_TEXT MSG="{escaped_msg}"
+       RESPOND TYPE=command MSG="{escaped_msg}"
+    {% else %}
+        SET_DISPLAY_TEXT
+    {% endif %}
+
+# SDCard 'looping' (aka Marlin M808 commands) support
+#
+# Support SDCard looping
+[sdcard_loop]
+[gcode_macro M486]
+gcode:
+    # Parameters known to M486 are as follows:
+    #   [C<flag>] Cancel the current object
+    #   [P<index>] Cancel the object with the given index
+    #   [S<index>] Set the index of the current object.
+    #       If the object with the given index has been canceled, this will cause
+    #       the firmware to skip to the next object. The value -1 is used to
+    #       indicate something that isn’t an object and shouldn’t be skipped.
+    #   [T<count>] Reset the state and set the number of objects
+    #   [U<index>] Un-cancel the object with the given index. This command will be
+    #       ignored if the object has already been skipped
+
+    {% if 'exclude_object' not in printer %}
+        {action_raise_error("[exclude_object] is not enabled")}
+    {% endif %}
+
+    {% if 'T' in params %}
+        EXCLUDE_OBJECT RESET=1
+
+      {% for i in range(params.T | int) %}
+        EXCLUDE_OBJECT_DEFINE NAME={i}
+      {% endfor %}
+    {% endif %}
+
+    {% if 'C' in params %}
+      EXCLUDE_OBJECT CURRENT=1
+    {% endif %}
+
+    {% if 'P' in params %}
+      EXCLUDE_OBJECT NAME={params.P}
+    {% endif %}
+
+    {% if 'S' in params %}
+        {% if params.S == '-1' %}
+            {% if printer.exclude_object.current_object %}
+                EXCLUDE_OBJECT_END NAME={printer.exclude_object.current_object}
+            {% endif %}
+        {% else %}
+            EXCLUDE_OBJECT_START NAME={params.S}
+        {% endif %}
+    {% endif %}
+
+    {% if 'U' in params %}
+        EXCLUDE_OBJECT RESET=1 NAME={params.U}
+    {% endif %}

kiauh/core/submodules/simple_config_parser/tests/assets/test_config_4.cfg

@@ -0,0 +1,116 @@
+# a comment at the very top
+# should be treated as the file header
+
+# up to the first section, including all blank lines
+
+[section_1]
+option_1: value_1
+option_1_1: True # this is a boolean
+option_1_2: 5 ; this is an integer
+option_1_3: 1.123 #;this is a float
+
+[section_2] ; comment
+option_2: value_2
+
+; comment
+
+[section_3]
+option_3: value_3 # comment
+
+[section_4]
+# comment
+option_4: value_4
+
+[section number 5]
+#option_5: value_5
+option_5 = this.is.value-5
+multi_option:
+    # these are multi-line values
+    value_5_1
+    value_5_2 ; here is a comment
+    value_5_3
+option_5_1: value_5_1
+
+[gcode_macro M117]
+rename_existing: M117.1
+gcode:
+    {% if rawparams %}
+       {% set escaped_msg = rawparams.split(';', 1)[0].split('\x23', 1)[0]|replace('"', '\\"') %}
+       SET_DISPLAY_TEXT MSG="{escaped_msg}"
+       RESPOND TYPE=command MSG="{escaped_msg}"
+    {% else %}
+        SET_DISPLAY_TEXT
+    {% endif %}
+
+# SDCard 'looping' (aka Marlin M808 commands) support
+#
+# Support SDCard looping
+[sdcard_loop]
+[gcode_macro M486]
+gcode:
+    # Parameters known to M486 are as follows:
+    #   [C<flag>] Cancel the current object
+    #   [P<index>] Cancel the object with the given index
+    #   [S<index>] Set the index of the current object.
+    #       If the object with the given index has been canceled, this will cause
+    #       the firmware to skip to the next object. The value -1 is used to
+    #       indicate something that isn’t an object and shouldn’t be skipped.
+    #   [T<count>] Reset the state and set the number of objects
+    #   [U<index>] Un-cancel the object with the given index. This command will be
+    #       ignored if the object has already been skipped
+
+    {% if 'exclude_object' not in printer %}
+        {action_raise_error("[exclude_object] is not enabled")}
+    {% endif %}
+
+    {% if 'T' in params %}
+        EXCLUDE_OBJECT RESET=1
+
+      {% for i in range(params.T | int) %}
+        EXCLUDE_OBJECT_DEFINE NAME={i}
+      {% endfor %}
+    {% endif %}
+
+    {% if 'C' in params %}
+      EXCLUDE_OBJECT CURRENT=1
+    {% endif %}
+
+    {% if 'P' in params %}
+      EXCLUDE_OBJECT NAME={params.P}
+    {% endif %}
+
+    {% if 'S' in params %}
+        {% if params.S == '-1' %}
+            {% if printer.exclude_object.current_object %}
+                EXCLUDE_OBJECT_END NAME={printer.exclude_object.current_object}
+            {% endif %}
+        {% else %}
+            EXCLUDE_OBJECT_START NAME={params.S}
+        {% endif %}
+    {% endif %}
+
+    {% if 'U' in params %}
+        EXCLUDE_OBJECT RESET=1 NAME={params.U}
+    {% endif %}
+
+#*# <---------------------- SAVE_CONFIG ---------------------->
+#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
+#*#
+#*# [bed_mesh default]
+#*# version = 1
+#*# points =
+#*# 	  -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
+#*# 	  -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
+#*# 	  -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
+#*# 	  -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
+#*# 	  -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
+#*# tension = 0.2
+#*# min_x = 26.0
+#*# algo = bicubic
+#*# y_count = 5
+#*# mesh_y_pps = 2
+#*# min_y = 5.0
+#*# x_count = 5
+#*# max_y = 174.0
+#*# mesh_x_pps = 2
+#*# max_x = 194.0

kiauh/core/submodules/simple_config_parser/tests/assets/test_gcode.cfg

@@ -0,0 +1,14 @@
+# Header line
+# Another header comment
+[toolhead]
+option_a: 1
+option_b: true
+
+[gcode_macro test]
+gcode: # start gcode block
+    G28 ; home all
+    M118 Done ; echo
+    G1 X10 Y10 F3000
+
+
+

kiauh/core/submodules/simple_config_parser/tests/assets/write_tests/add_option/expected.cfg

@@ -0,0 +1,8 @@
+[section_1]
+# comment
+option_1: value_1
+option_2: value_2 ; comment
+new_option: new_value
+
+[section_2]
+option_3: value_3

kiauh/core/submodules/simple_config_parser/tests/assets/write_tests/add_option/input.cfg

@@ -0,0 +1,7 @@
+[section_1]
+# comment
+option_1: value_1
+option_2: value_2 ; comment
+
+[section_2]
+option_3: value_3

kiauh/core/submodules/simple_config_parser/tests/assets/write_tests/remove_option/expected.cfg

@@ -0,0 +1,7 @@
+[section_1]
+# comment
+option_1: value_1
+option_2: value_2 ; comment
+
+[section_2]
+option_3: value_3

kiauh/core/submodules/simple_config_parser/tests/assets/write_tests/remove_option/input.cfg

@@ -0,0 +1,8 @@
+[section_1]
+# comment
+option_1: value_1
+option_to_remove: value_to_remove
+option_2: value_2 ; comment
+
+[section_2]
+option_3: value_3

kiauh/core/submodules/simple_config_parser/tests/assets/write_tests/remove_section/expected.cfg

@@ -0,0 +1,7 @@
+[section_1]
+option_1: value_1
+option_2: value_2
+
+# comment
+[section_2]
+option_5: value_5

kiauh/core/submodules/simple_config_parser/tests/assets/write_tests/remove_section/input.cfg

@@ -0,0 +1,11 @@
+[section_1]
+option_1: value_1
+option_2: value_2
+
+# comment
+[section_to_remove]
+option_3: value_3
+option_4: value_4
+
+[section_2]
+option_5: value_5

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_gcode_block_start/test_data/matching_data.txt

@@ -0,0 +1,16 @@
+gcode:
+gcode:
+gcode: # comment
+gcode: ; comment
+gcode :
+gcode :
+gcode : # comment
+gcode : ; comment
+gcode=
+gcode=
+gcode= # comment
+gcode= ; comment
+gcode =
+gcode =
+gcode = # comment
+gcode = ; comment