docs: add Raspberry Pi setup guide and update installation instructions

Signed-off-by: Dominik Willner <th33xitus@gmail.com>

.editorconfig

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

.github/workflows/deploy-docs.yml

@@ -0,0 +1,31 @@
+name: Deploy Documentation
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - docs
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Build and deploy documentation
+        run: mkdocs gh-deploy --force

.gitignore

@@ -10,4 +10,3 @@ __pycache__
 *.code-workspace
 *.iml
 kiauh.cfg
-klipper_repos.txt

Dockerfile

@@ -0,0 +1,6 @@
+FROM squidfunk/mkdocs-material:latest
+
+# Install additional plugins required by our mkdocs configuration
+RUN pip install \
+    mkdocs-git-revision-date-localized-plugin \
+    mkdocstrings[python]

default.kiauh.cfg

@@ -0,0 +1,36 @@
+[kiauh]
+backup_before_update: False
+
+[klipper]
+# 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]
+# 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: 80
+unstable_releases: False

docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  mkdocs:
+    build: .
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./:/docs
+    command: serve --dev-addr=0.0.0.0:8000

docs/development/changelog.md

@@ -276,7 +276,7 @@ Each service gets its corresponding instance added to the service filename.
 
 * 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](extensions/gcode-shell-command) 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]`.
 

docs/extensions/index.md

@@ -0,0 +1 @@
+# Community Extensions

docs/index.md

@@ -0,0 +1,23 @@
+!!! tip "Important"
+    This documentation is for KIAUH version 6 and still work in progress!
+
+<h1 align="center">
+  KIAUH - Klipper Installation And Update Helper
+</h1>
+
+<p align="center">
+  <img src="assets/logo-large.png" alt="KIAUH logo" width="400"/>
+</p>
+<p align="center" style="font-size: 1.2em; font-weight: bold;">
+  A handy installation script that makes installing Klipper (and more) a breeze!
+</p>
+
+
+## Features
+
+- Easy installation of Klipper and related components
+- Support for multiple instances
+- Extension system for additional functionality
+- Configuration management
+- And more!
+

docs/setup/installation.md

@@ -0,0 +1,39 @@
+# Installing KIAUH
+
+In the following sections, you will be guided through the installation
+process step-by-step.
+
+To use KIAUH, it is enough to download the script and run it on your
+Raspberry Pi or other compatible device. If you need to know how to
+set up a Raspberry Pi or if you are unsure whether your current setup
+is sufficient, please refer to the [Raspberry Pi Installation Guide](raspberry-pi-setup.md)
+and follow the steps therein. Afterwards, you can return to this guide to install KIAUH.
+
+### Prerequisites
+Before you can download and run KIAUH, you need to ensure that ``git`` is
+installed on your system. Open a terminal and run the following command:
+
+```bash
+sudo apt-get update && sudo apt-get install git -y
+```
+
+### Downloading KIAUH
+After `git` was successfully installed, you can download KIAUH by
+cloning the repository from GitHub. It is recommended to clone it into
+your home directory. Run the following command in your terminal:
+```bash
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
+
+### Running KIAUH
+Once the repository is cloned, you can start KIAUH. Make sure you are in
+your home directory and execute the script by running the following
+command:
+```bash
+./kiauh/kiauh.sh
+```
+
+After executing the command, you will be presented with the KIAUH menu,
+which allows you to install and manage various 3D printing software.
+For more information on how to use KIAUH, please refer to the
+[Usage Guide](usage.md).

docs/setup/raspberry-pi-setup.md

@@ -0,0 +1,49 @@
+# Raspberry Pi Setup
+
+This guide will help you set up a Raspberry Pi for running Klipper and other,
+Klipper related 3D printing software. In case you are using a different single-board
+computer (SBC), please refer to the manufacturer's instructions for installing
+a compatible version of Linux on your device.
+
+It is assumed that you have at least a Raspberry Pi 3 or newer, along with a
+microSD card (at least 8GB, preferably 16GB or more) and a power supply.
+Additionally, you will need a computer with an SD card reader to prepare
+the microSD card.
+
+KIAUH requires a Linux operating system that has already been flashed to your
+Raspberry Pi's (or other SBC's) microSD card. As a result, you must ensure that you
+already have a functional Linux system on hand before you can proceed with
+installing KIAUH. `Raspberry Pi OS Lite` (either 32bit or 64bit) is a recommended Linux image
+if you are using a Raspberry Pi.
+
+---
+
+To flash `Raspberry Pi OS Lite` to your microSD card using the official [Raspberry Pi Imager](https://www.raspberrypi.com/software/),
+follow the steps below. If you encounter any issues or need further assistance, please refer to the [official Raspberry Pi documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
+
+1. Open the Raspberry Pi Imager application on your computer.
+2. Click on `Choose OS` and select `Raspberry Pi OS (other)`.
+   ![OS selection](https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png)
+3. Choose `Raspberry Pi OS Lite (32bit)` (or 64bit if desired).
+   ![Lite selection](https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png)
+4. Insert the microSD card into your computer's SD card reader.
+5. In the main menu of the Imager, select the correct microSD card.
+6. Click the gear icon at the bottom left of the main menu to open advanced options.
+7. Enable SSH and enter your Wi-Fi credentials.
+
+    !!! info
+        Wi-Fi is only necessary if you want to connect to your Raspberry Pi over a wireless network. If you plan to use a wired Ethernet connection, you can skip this step. SSH is required for remote access to your Raspberry Pi, so make sure to enable it.
+
+8. Click `Save` to close the advanced options menu.
+9. Click `Write` to start flashing the image to the microSD card.
+
+    !!! warning
+        All data on the microSD card will be overwritten!
+
+10. Once the flashing process is complete, safely eject the microSD card from your computer.
+11. Insert the microSD card into your Raspberry Pi.
+12. Connect your Raspberry Pi to a power source to boot it up.
+13. Wait for a few minutes to allow the Raspberry Pi to complete its initial setup.
+14. You can now connect to your Raspberry Pi via SSH using the IP address assigned by your router. The default username is `pi` and the default password is `raspberry`.
+
+If you successfully connected to your Raspberry Pi via SSH, you can proceed to install KIAUH by following the instructions in the [Installation Guide](installation.md).

kiauh.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  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 kiauh.main import main
+
+if __name__ == "__main__":
+    main()

kiauh.sh

@@ -57,15 +57,121 @@ 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 "|${green}              New KIAUH update available!              ${white}|"
+  hr
+  echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
+  blank_line
+  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
+
+  local yn
+  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
+  while true; do
+    case "${yn}" in
+     Y|y|Yes|yes|"")
+       do_action "update_kiauh"
+       break;;
+     N|n|No|no)
+       break;;
+     *)
+       deny_action "kiauh_update_dialog";;
+    esac
+  done
+}
+
+function launch_kiauh_v5() {
+    main_menu
+}
+
+function launch_kiauh_v6() {
+  local entrypoint
+
+  if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
+    echo "Python 3.8 or higher is not installed!"
+    echo "Please install Python 3.8 or higher and try again."
+    exit 1
+  fi
+
+  entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+
+  export PYTHONPATH="${entrypoint}"
+
+  clear -x
+  python3 "${entrypoint}/kiauh.py"
+}
+
 function main() {
   read_kiauh_ini "${FUNCNAME[0]}"
-  main_menu
+
+  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
 }
 
 check_if_ratos
 check_euid
 init_logfile
 set_globals
+kiauh_update_dialog
 read_kiauh_ini
 init_ini
 main

kiauh/__init__.py

@@ -0,0 +1,15 @@
+# ======================================================================= #
+#  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 sys
+from pathlib import Path
+
+PROJECT_ROOT = Path(__file__).resolve().parent.parent
+APPLICATION_ROOT = Path(__file__).resolve().parent
+sys.path.append(str(APPLICATION_ROOT))

kiauh/components/crowsnest/__init__.py

@@ -0,0 +1,30 @@
+# ======================================================================= #
+#  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 pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
+
+# repo
+CROWSNEST_REPO = "https://github.com/mainsail-crew/crowsnest.git"
+
+# names
+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")
+CROWSNEST_INSTALL_SCRIPT = CROWSNEST_DIR.joinpath("tools/install.sh")
+CROWSNEST_BIN_FILE = Path("/usr/local/bin/crowsnest")
+CROWSNEST_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
+CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)

kiauh/components/crowsnest/crowsnest.py

@@ -0,0 +1,177 @@
+# ======================================================================= #
+#  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
+import time
+from pathlib import Path
+from subprocess import CalledProcessError, run
+from typing import List
+
+from components.crowsnest import (
+    CROWSNEST_BACKUP_DIR,
+    CROWSNEST_BIN_FILE,
+    CROWSNEST_DIR,
+    CROWSNEST_INSTALL_SCRIPT,
+    CROWSNEST_LOGROTATE_FILE,
+    CROWSNEST_MULTI_CONFIG,
+    CROWSNEST_REPO,
+    CROWSNEST_SERVICE_FILE,
+    CROWSNEST_SERVICE_NAME,
+)
+from components.klipper.klipper import Klipper
+from core.backup_manager.backup_manager import BackupManager
+from core.logger import DialogType, Logger
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.component_status import ComponentStatus
+from utils.common import (
+    check_install_dependencies,
+    get_install_status,
+)
+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_service,
+    parse_packages_from_file,
+)
+
+
+def install_crowsnest() -> None:
+    # Step 1: Clone crowsnest repo
+    git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+
+    # Step 2: Install dependencies
+    check_install_dependencies({"make"})
+
+    # Step 3: Check for Multi Instance
+    instances: List[Klipper] = get_instances(Klipper)
+
+    if len(instances) > 1:
+        print_multi_instance_warning(instances)
+
+        if not get_confirm("Do you want to continue with the installation?"):
+            Logger.print_info("Crowsnest installation aborted!")
+            return
+
+        Logger.print_status("Launching crowsnest's install configurator ...")
+        time.sleep(3)
+        configure_multi_instance()
+
+    # Step 4: Launch crowsnest installer
+    Logger.print_status("Launching crowsnest installer ...")
+    Logger.print_info("Installer will prompt you for sudo password!")
+    try:
+        run(
+            "sudo make install",
+            cwd=CROWSNEST_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        return
+
+
+def print_multi_instance_warning(instances: List[Klipper]) -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "Multi instance install detected!",
+            "\n\n",
+            "Crowsnest is NOT designed to support multi instances. A workaround "
+            "for this is to choose the most used instance as a 'master' and use "
+            "this instance to set up your 'crowsnest.conf' and steering it's service.",
+            "\n\n",
+            "The following instances were found:",
+            *[f"● {instance.data_dir.name}" for instance in instances],
+        ],
+    )
+
+
+def configure_multi_instance() -> None:
+    try:
+        run(
+            "make config",
+            cwd=CROWSNEST_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        if CROWSNEST_MULTI_CONFIG.exists():
+            Path.unlink(CROWSNEST_MULTI_CONFIG)
+        return
+
+    if not CROWSNEST_MULTI_CONFIG.exists():
+        Logger.print_error("Generating .config failed, installation aborted")
+
+
+def update_crowsnest() -> None:
+    try:
+        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "stop")
+
+        if not CROWSNEST_DIR.exists():
+            git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+        else:
+            Logger.print_status("Updating Crowsnest ...")
+
+            settings = KiauhSettings()
+            if settings.kiauh.backup_before_update:
+                bm = BackupManager()
+                bm.backup_directory(
+                    CROWSNEST_DIR.name,
+                    source=CROWSNEST_DIR,
+                    target=CROWSNEST_BACKUP_DIR,
+                )
+
+            git_pull_wrapper(CROWSNEST_DIR)
+
+            deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
+            check_install_dependencies({*deps})
+
+        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
+
+        Logger.print_ok("Crowsnest updated successfully.", end="\n\n")
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        return
+
+
+def get_crowsnest_status() -> ComponentStatus:
+    files = [
+        CROWSNEST_BIN_FILE,
+        CROWSNEST_LOGROTATE_FILE,
+        CROWSNEST_SERVICE_FILE,
+    ]
+    return get_install_status(CROWSNEST_DIR, files=files)
+
+
+def remove_crowsnest() -> None:
+    if not CROWSNEST_DIR.exists():
+        Logger.print_info("Crowsnest does not seem to be installed! Skipping ...")
+        return
+
+    try:
+        run(
+            "make uninstall",
+            cwd=CROWSNEST_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        return
+
+    Logger.print_status("Removing crowsnest directory ...")
+    shutil.rmtree(CROWSNEST_DIR)
+    Logger.print_ok("Directory removed!")

kiauh/components/klipper/__init__.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  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 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"
+KLIPPER_SERIAL_NAME = "klippy.serial"
+KLIPPER_UDS_NAME = "klippy.sock"
+KLIPPER_ENV_FILE_NAME = "klipper.env"
+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")
+KLIPPER_INSTALL_SCRIPT = KLIPPER_DIR.joinpath("scripts/install-ubuntu-22.04.sh")
+KLIPPER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_SERVICE_NAME}")
+KLIPPER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_ENV_FILE_NAME}")
+
+
+EXIT_KLIPPER_SETUP = "Exiting Klipper setup ..."

kiauh/components/klipper/assets/klipper.env

@@ -0,0 +1 @@
+KLIPPER_ARGS="%KLIPPER_DIR%/klippy/klippy.py %CFG% -I %SERIAL% -l %LOG% -a %UDS%"

kiauh/components/klipper/assets/klipper.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=Klipper 3D Printer Firmware SV1
+Documentation=https://www.klipper3d.org/
+After=network-online.target
+Wants=udev.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+RemainAfterExit=yes
+WorkingDirectory=%KLIPPER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $KLIPPER_ARGS
+Restart=always
+RestartSec=10

kiauh/components/klipper/assets/printer.cfg

@@ -0,0 +1,11 @@
+[mcu]
+serial: /dev/serial/by-id/<your-mcu-id>
+
+[virtual_sdcard]
+path: %GCODES_DIR%
+on_error_gcode: CANCEL_PRINT
+
+[printer]
+kinematics: none
+max_velocity: 1000
+max_accel: 1000

kiauh/components/klipper/klipper.py

@@ -0,0 +1,142 @@
+# ======================================================================= #
+#  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 pathlib import Path
+from subprocess import CalledProcessError
+
+from components.klipper import (
+    KLIPPER_CFG_NAME,
+    KLIPPER_DIR,
+    KLIPPER_ENV_DIR,
+    KLIPPER_ENV_FILE_NAME,
+    KLIPPER_ENV_FILE_TEMPLATE,
+    KLIPPER_LOG_NAME,
+    KLIPPER_SERIAL_NAME,
+    KLIPPER_SERVICE_TEMPLATE,
+    KLIPPER_UDS_NAME,
+)
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from utils.fs_utils import create_folders, get_data_dir
+from utils.sys_utils import get_service_file_path
+
+
+# noinspection PyMethodMayBeStatic
+@dataclass(repr=True)
+class Klipper:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name: str = KLIPPER_LOG_NAME
+    klipper_dir: Path = KLIPPER_DIR
+    env_dir: Path = KLIPPER_ENV_DIR
+    data_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+    env_file: Path = field(init=False)
+    serial: Path = field(init=False)
+    uds: Path = field(init=False)
+
+    def __post_init__(self):
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        self.base.log_file_name = self.log_file_name
+
+        self.service_file_path: Path = get_service_file_path(Klipper, self.suffix)
+        self.data_dir: Path = get_data_dir(Klipper, self.suffix)
+        self.cfg_file: Path = self.base.cfg_dir.joinpath(KLIPPER_CFG_NAME)
+        self.env_file: Path = self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME)
+        self.serial: Path = self.base.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
+        self.uds: Path = self.base.comms_dir.joinpath(KLIPPER_UDS_NAME)
+
+    def create(self) -> None:
+        from utils.sys_utils import create_env_file, create_service_file
+
+        Logger.print_status("Creating new Klipper Instance ...")
+
+        try:
+            create_folders(self.base.base_folders)
+
+            create_service_file(
+                name=self.service_file_path.name,
+                content=self._prep_service_file_content(),
+            )
+
+            create_env_file(
+                path=self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
+                content=self._prep_env_file_content(),
+            )
+
+        except CalledProcessError as e:
+            Logger.print_error(f"Error creating instance: {e}")
+            raise
+        except OSError as e:
+            Logger.print_error(f"Error creating env file: {e}")
+            raise
+
+    def _prep_service_file_content(self) -> str:
+        template = KLIPPER_SERVICE_TEMPLATE
+
+        try:
+            with open(template, "r") as template_file:
+                template_content = template_file.read()
+        except FileNotFoundError:
+            Logger.print_error(f"Unable to open {template} - File not found")
+            raise
+
+        service_content = template_content.replace(
+            "%USER%",
+            CURRENT_USER,
+        )
+        service_content = service_content.replace(
+            "%KLIPPER_DIR%",
+            self.klipper_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV%",
+            self.env_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV_FILE%",
+            self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
+        )
+        return service_content
+
+    def _prep_env_file_content(self) -> str:
+        template = KLIPPER_ENV_FILE_TEMPLATE
+
+        try:
+            with open(template, "r") as env_file:
+                env_template_file_content = env_file.read()
+        except FileNotFoundError:
+            Logger.print_error(f"Unable to open {template} - File not found")
+            raise
+
+        env_file_content = env_template_file_content.replace(
+            "%KLIPPER_DIR%", self.klipper_dir.as_posix()
+        )
+        env_file_content = env_file_content.replace(
+            "%CFG%",
+            f"{self.base.cfg_dir}/{KLIPPER_CFG_NAME}",
+        )
+        env_file_content = env_file_content.replace(
+            "%SERIAL%",
+            self.serial.as_posix() if self.serial else "",
+        )
+        env_file_content = env_file_content.replace(
+            "%LOG%",
+            self.base.log_dir.joinpath(self.log_file_name).as_posix(),
+        )
+        env_file_content = env_file_content.replace(
+            "%UDS%",
+            self.uds.as_posix() if self.uds else "",
+        )
+
+        return env_file_content

kiauh/components/klipper/klipper_dialogs.py

@@ -0,0 +1,113 @@
+# ======================================================================= #
+#  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 textwrap
+from enum import Enum, unique
+from typing import List
+
+from core.menus.base_menu import print_back_footer
+from core.types.color import Color
+from utils.instance_type import InstanceType
+
+
+@unique
+class DisplayType(Enum):
+    SERVICE_NAME = "SERVICE_NAME"
+    PRINTER_NAME = "PRINTER_NAME"
+
+
+def print_instance_overview(
+    instances: List[InstanceType],
+    display_type: DisplayType = DisplayType.SERVICE_NAME,
+    show_headline=True,
+    show_index=False,
+    start_index=0,
+    show_select_all=False,
+) -> None:
+    dialog = "╔═══════════════════════════════════════════════════════╗\n"
+    if show_headline:
+        d_type = (
+            "Klipper instances"
+            if display_type is DisplayType.SERVICE_NAME
+            else "printer directories"
+        )
+        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 = Color.apply("a) Select all", Color.YELLOW)
+        dialog += f"║ {select_all:<63}║\n"
+        dialog += "║                                                       ║\n"
+
+    for i, s in enumerate(instances):
+        if display_type is DisplayType.SERVICE_NAME:
+            name = s.service_file_path.stem
+        else:
+            name = s.data_dir
+        line = Color.apply(
+            f"{f'{i + start_index})' if show_index else '●'} {name}", Color.CYAN
+        )
+        dialog += f"║ {line:<63}║\n"
+    dialog += "╟───────────────────────────────────────────────────────╢\n"
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_select_instance_count_dialog() -> None:
+    line1 = Color.apply("WARNING:", Color.YELLOW)
+    line2 = Color.apply(
+        "Setting up too many instances may crash your system.", Color.YELLOW
+    )
+    dialog = textwrap.dedent(
+        f"""
+        ╔═══════════════════════════════════════════════════════╗
+        ║ Please select the number of Klipper instances to set  ║
+        ║ up. The number of Klipper instances will determine    ║
+        ║ the amount of printers you can run from this host.    ║
+        ║                                                       ║
+        ║ {line1:<63}║
+        ║ {line2:<63}║
+        ╟───────────────────────────────────────────────────────╢
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_select_custom_name_dialog() -> None:
+    line1 = Color.apply("INFO:", Color.YELLOW)
+    line2 = Color.apply("Only alphanumeric characters are allowed!", Color.YELLOW)
+    dialog = textwrap.dedent(
+        f"""
+        ╔═══════════════════════════════════════════════════════╗
+        ║ Do you want to assign a custom name to each instance? ║
+        ║                                                       ║
+        ║ Assigning a custom name will create a Klipper service ║
+        ║ and a printer directory with the chosen name.         ║
+        ║                                                       ║
+        ║ Example for custom name 'kiauh':                      ║
+        ║  ● Klipper service:   klipper-kiauh.service           ║
+        ║  ● Printer directory: printer_kiauh_data              ║
+        ║                                                       ║
+        ║ If skipped, each instance will get an index assigned  ║
+        ║ in ascending order, starting at '1' in case of a new  ║
+        ║ installation. Otherwise, the index will be derived    ║
+        ║ from amount of already existing instances.            ║
+        ║                                                       ║
+        ║ {line1:<63}║
+        ║ {line2:<63}║
+        ╟───────────────────────────────────────────────────────╢
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()

kiauh/components/klipper/klipper_utils.py

@@ -0,0 +1,256 @@
+# ======================================================================= #
+#  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 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
+from components.klipper.klipper_dialogs import (
+    print_instance_overview,
+    print_select_instance_count_dialog,
+)
+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.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+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,
+    install_python_packages,
+    parse_packages_from_file,
+)
+
+
+def get_klipper_status() -> ComponentStatus:
+    return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, Klipper)
+
+
+def add_to_existing() -> bool | None:
+    kl_instances: List[Klipper] = get_instances(Klipper)
+    print_instance_overview(kl_instances)
+    _input: bool | None = get_confirm("Add new instances?", allow_go_back=True)
+    return _input
+
+
+def get_install_count() -> int | None:
+    """
+    Print a dialog for selecting the amount of Klipper instances
+    to set up with an option to navigate back. Returns None if the
+    user selected to go back, otherwise an integer greater or equal than 1 |
+    :return: Integer >= 1 or None
+    """
+    kl_instances = get_instances(Klipper)
+    print_select_instance_count_dialog()
+    question = (
+        f"Number of"
+        f"{' additional' if len(kl_instances) > 0 else ''} "
+        f"Klipper instances to set up"
+    )
+    _input: int | None = get_number_input(question, 1, default=1, allow_go_back=True)
+    return _input
+
+
+def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
+    existing_names = []
+    existing_names.extend(SUFFIX_BLACKLIST)
+    existing_names.extend(name_dict[n] for n in name_dict)
+    pattern = r"^[a-zA-Z0-9]+$"
+
+    question = f"Enter name for instance {key}"
+    name_dict[key] = get_string_input(question, exclude=existing_names, regex=pattern)
+
+
+def check_user_groups() -> None:
+    user_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
+    missing_groups = [g for g in ["tty", "dialout"] if g not in user_groups]
+
+    if not missing_groups:
+        return
+
+    Logger.print_dialog(
+        DialogType.ATTENTION,
+        [
+            "Your current user is not in group:",
+            *[f"● {g}" for g in missing_groups],
+            "\n\n",
+            "It is possible that you won't be able to successfully connect and/or "
+            "flash the controller board without your user being a member of that "
+            "group. If you want to add the current user to the group(s) listed above, "
+            "answer with 'Y'. Else skip with 'n'.",
+            "\n\n",
+            "INFO:",
+            "Relog required for group assignments to take effect!",
+        ],
+    )
+
+    if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
+        log = "Skipped adding user to required groups. You might encounter issues."
+        Logger.warn(log)
+        return
+
+    try:
+        for group in missing_groups:
+            Logger.print_status(f"Adding user '{CURRENT_USER}' to group {group} ...")
+            command = ["sudo", "usermod", "-a", "-G", group, CURRENT_USER]
+            run(command, check=True)
+            Logger.print_ok(f"Group {group} assigned to user '{CURRENT_USER}'.")
+    except CalledProcessError as e:
+        Logger.print_error(f"Unable to add user to usergroups: {e}")
+        raise
+
+    log = "Remember to relog/restart this machine for the group(s) to be applied!"
+    Logger.print_warn(log)
+
+
+def handle_disruptive_system_packages() -> None:
+    services = []
+
+    command = ["systemctl", "is-enabled", "brltty"]
+    brltty_status = run(command, capture_output=True, text=True)
+
+    command = ["systemctl", "is-enabled", "brltty-udev"]
+    brltty_udev_status = run(command, capture_output=True, text=True)
+
+    command = ["systemctl", "is-enabled", "ModemManager"]
+    modem_manager_status = run(command, capture_output=True, text=True)
+
+    if "enabled" in brltty_status.stdout:
+        services.append("brltty")
+    if "enabled" in brltty_udev_status.stdout:
+        services.append("brltty-udev")
+    if "enabled" in modem_manager_status.stdout:
+        services.append("ModemManager")
+
+    for service in services if services else []:
+        try:
+            cmd_sysctl_service(service, "mask")
+        except CalledProcessError:
+            Logger.print_dialog(
+                DialogType.WARNING,
+                [
+                    f"KIAUH was unable to mask the {service} system service. "
+                    "Please fix the problem manually. Otherwise, this may have "
+                    "undesirable effects on the operation of Klipper."
+                ],
+            )
+
+
+def create_example_printer_cfg(
+    instance: Klipper, clients: List[BaseWebClient] | None = None
+) -> None:
+    Logger.print_status(f"Creating example printer.cfg in '{instance.base.cfg_dir}'")
+    if instance.cfg_file.is_file():
+        Logger.print_info(f"'{instance.cfg_file}' already exists.")
+        return
+
+    source = MODULE_PATH.joinpath("assets/printer.cfg")
+    target = instance.cfg_file
+    try:
+        shutil.copy(source, target)
+    except OSError as e:
+        Logger.print_error(f"Unable to create example printer.cfg:\n{e}")
+        return
+
+    scp = SimpleConfigParser()
+    scp.read_file(target)
+    scp.set_option("virtual_sdcard", "path", str(instance.base.gcodes_dir))
+
+    # include existing client configs in the example config
+    if clients is not None and len(clients) > 0:
+        for c in clients:
+            client_config = c.client_config
+            section = client_config.config_section
+            scp.add_section(section=section)
+            create_client_config_symlink(client_config, [instance])
+
+    scp.write_file(target)
+
+    Logger.print_ok(f"Example printer.cfg created in '{instance.base.cfg_dir}'")
+
+
+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)
+
+
+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",
+            "● libatlas-base-dev",
+            "● 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",
+        "libatlas-base-dev",
+        "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

@@ -0,0 +1,102 @@
+# ======================================================================= #
+#  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.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.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
+
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "a": Option(method=self.toggle_all),
+            "1": Option(method=self.toggle_remove_klipper_service),
+            "2": Option(method=self.toggle_remove_klipper_dir),
+            "3": Option(method=self.toggle_remove_klipper_env),
+            "c": Option(method=self.run_removal_process),
+        }
+
+    def print_menu(self) -> None:
+        checked = f"[{Color.apply('x', Color.CYAN)}]"
+        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"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ Enter a number and hit enter to select / deselect     ║
+            ║ the specific option for removal.                      ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  a) {sel_state:49} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  1) {o1} Remove Service                                ║
+            ║  2) {o2} Remove Local Repository                       ║
+            ║  3) {o3} Remove Python Environment                     ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  C) Continue                                          ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        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.rm_svc = not self.rm_svc
+
+    def toggle_remove_klipper_dir(self, **kwargs) -> None:
+        self.rm_dir = not self.rm_dir
+
+    def toggle_remove_klipper_env(self, **kwargs) -> None:
+        self.rm_env = not self.rm_env
+
+    def run_removal_process(self, **kwargs) -> None:
+        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
+
+        self.klsvc.remove(self.rm_svc, self.rm_dir, self.rm_env)
+
+        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

@@ -0,0 +1,12 @@
+# ======================================================================= #
+#  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 components.klipper import KLIPPER_DIR
+
+SD_FLASH_SCRIPT = KLIPPER_DIR.joinpath("scripts/flash-sdcard.sh")

kiauh/components/klipper_firmware/firmware_utils.py

@@ -0,0 +1,213 @@
+# ======================================================================= #
+#  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 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
+from components.klipper.klipper import Klipper
+from components.klipper_firmware import SD_FLASH_SCRIPT
+from components.klipper_firmware.flash_options import (
+    FlashMethod,
+    FlashOptions,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from utils.instance_utils import get_instances
+from utils.sys_utils import log_process
+
+
+def find_firmware_file() -> bool:
+    target = KLIPPER_DIR.joinpath("out")
+    target_exists: bool = target.exists()
+
+    f1 = "klipper.elf.hex"
+    f2 = "klipper.elf"
+    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()
+    )
+
+    return target_exists and fw_file_exists
+
+
+def find_usb_device_by_id() -> List[str]:
+    try:
+        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!")
+        Logger.print_error(e, prefix=False)
+        return []
+
+
+def find_uart_device() -> List[str]:
+    try:
+        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)
+        return []
+
+
+def find_usb_dfu_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 "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 []
+
+    try:
+        cmd = f"{SD_FLASH_SCRIPT} -l"
+        blist: List[str] = check_output(cmd, shell=True, text=True).splitlines()[1:]
+        return blist
+    except CalledProcessError as e:
+        Logger.print_error(f"An unexpected error occured:\n{e}")
+        return []
+
+
+def start_flash_process(flash_options: FlashOptions) -> None:
+    Logger.print_status(f"Flashing '{flash_options.selected_mcu}' ...")
+    try:
+        if not flash_options.flash_method:
+            raise Exception("Missing value for flash_method!")
+        if not flash_options.flash_command:
+            raise Exception("Missing value for flash_command!")
+        if not flash_options.selected_mcu:
+            raise Exception("Missing value for selected_mcu!")
+        if not flash_options.connection_type:
+            raise Exception("Missing value for connection_type!")
+        if (
+            flash_options.flash_method == FlashMethod.SD_CARD
+            and not flash_options.selected_board
+        ):
+            raise Exception("Missing value for selected_board!")
+
+        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}",
+            ]
+        elif flash_options.flash_method is FlashMethod.SD_CARD:
+            if not SD_FLASH_SCRIPT.exists():
+                raise Exception("Unable to find Klippers sdcard flash script!")
+            cmd = [
+                SD_FLASH_SCRIPT.as_posix(),
+                f"-b {flash_options.selected_baudrate}",
+                flash_options.selected_mcu,
+                flash_options.selected_board,
+            ]
+        else:
+            raise Exception("Invalid value for flash_method!")
+
+        instances = get_instances(Klipper)
+        InstanceManager.stop_all(instances)
+
+        process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
+        log_process(process)
+
+        InstanceManager.start_all(instances)
+
+        rc = process.returncode
+        if rc != 0:
+            raise Exception(f"Flashing failed with returncode: {rc}")
+        else:
+            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(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
+    try:
+        run(
+            f"make KCONFIG_CONFIG={kconfig} clean",
+            cwd=KLIPPER_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Unexpected error:\n{e}")
+        raise
+
+
+def run_make_menuconfig(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
+    try:
+        run(
+            f"make PYTHON=python3 KCONFIG_CONFIG={kconfig} menuconfig",
+            cwd=KLIPPER_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Unexpected error:\n{e}")
+        raise
+
+
+def run_make(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
+    try:
+        run(
+            f"make PYTHON=python3 KCONFIG_CONFIG={kconfig}",
+            cwd=KLIPPER_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Unexpected error:\n{e}")
+        raise

kiauh/components/klipper_firmware/flash_options.py

@@ -0,0 +1,115 @@
+# ======================================================================= #
+#  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 field
+from enum import Enum
+from typing import List
+
+
+class FlashMethod(Enum):
+    REGULAR = "Regular"
+    SD_CARD = "SD Card"
+
+
+class FlashCommand(Enum):
+    FLASH = "flash"
+    SERIAL_FLASH = "serialflash"
+
+
+class ConnectionType(Enum):
+    USB = "USB"
+    USB_DFU = "USB (DFU)"
+    USB_RP2040 = "USB (RP2040)"
+    UART = "UART"
+
+
+class FlashOptions:
+    _instance = None
+    _flash_method: FlashMethod | None = None
+    _flash_command: FlashCommand | None = None
+    _connection_type: ConnectionType | None = None
+    _mcu_list: List[str] = field(default_factory=list)
+    _selected_mcu: str = ""
+    _selected_board: str = ""
+    _selected_baudrate: int = 250000
+    _selected_kconfig: str = ".config"
+
+    def __new__(cls, *args, **kwargs):
+        if not cls._instance:
+            cls._instance = super(FlashOptions, cls).__new__(cls, *args, **kwargs)
+        return cls._instance
+
+    @classmethod
+    def destroy(cls) -> None:
+        cls._instance = None
+
+    @property
+    def flash_method(self) -> FlashMethod | None:
+        return self._flash_method
+
+    @flash_method.setter
+    def flash_method(self, value: FlashMethod | None):
+        self._flash_method = value
+
+    @property
+    def flash_command(self) -> FlashCommand | None:
+        return self._flash_command
+
+    @flash_command.setter
+    def flash_command(self, value: FlashCommand | None):
+        self._flash_command = value
+
+    @property
+    def connection_type(self) -> ConnectionType | None:
+        return self._connection_type
+
+    @connection_type.setter
+    def connection_type(self, value: ConnectionType | None):
+        self._connection_type = value
+
+    @property
+    def mcu_list(self) -> List[str]:
+        return self._mcu_list
+
+    @mcu_list.setter
+    def mcu_list(self, value: List[str]) -> None:
+        self._mcu_list = value
+
+    @property
+    def selected_mcu(self) -> str:
+        return self._selected_mcu
+
+    @selected_mcu.setter
+    def selected_mcu(self, value: str) -> None:
+        self._selected_mcu = value
+
+    @property
+    def selected_board(self) -> str:
+        return self._selected_board
+
+    @selected_board.setter
+    def selected_board(self, value: str) -> None:
+        self._selected_board = value
+
+    @property
+    def selected_baudrate(self) -> int:
+        return self._selected_baudrate
+
+    @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

@@ -0,0 +1,274 @@
+# ======================================================================= #
+#  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 pathlib import Path
+from shutil import copyfile
+from typing import List, Set, Type
+
+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 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,
+    update_system_package_lists,
+)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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.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
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else AdvancedMenu
+        )
+
+    def set_options(self) -> None:
+        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:
+        txt = Color.apply("Dependencies are missing!", Color.RED)
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {txt:^62} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ The following dependencies are required:              ║
+            ║                                                       ║
+            """
+        )[1:]
+
+        for d in self.deps:
+            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 = 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"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+
+        print(menu, end="")
+
+    def install_missing_deps(self, **kwargs) -> None:
+        try:
+            update_system_package_lists(silent=False)
+            Logger.print_status("Installing system packages...")
+            install_system_packages(self.missing_deps)
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Installing dependencies failed!")
+        finally:
+            # restart this menu
+            KlipperBuildFirmwareMenu().run()
+
+    def start_build_process(self, **kwargs) -> None:
+        try:
+            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!")
+
+        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

@@ -0,0 +1,107 @@
+# ======================================================================= #
+#  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.klipper_firmware.flash_options import FlashMethod, FlashOptions
+from core.menus import FooterType, Option
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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()
+        self.footer_type = FooterType.BLANK
+        self.input_label_txt = "Press ENTER to go back to [Advanced Menu]"
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = previous_menu
+
+    def set_options(self) -> None:
+        self.default_option = Option(method=self.go_back)
+
+    def print_menu(self) -> None:
+        line1 = "Unable to find a compiled firmware file!"
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {Color.apply(line1, Color.RED):<62} ║
+            ║                                                       ║
+            ║ Make sure, that:                                      ║
+            ║ ● the folder '~/klipper/out' and its content exist    ║
+            ║ ● the folder contains the following file:             ║
+            """
+        )[1:]
+
+        if self.flash_options.flash_method is FlashMethod.REGULAR:
+            menu += "║   ● 'klipper.elf'                                     ║\n"
+            menu += "║   ● 'klipper.elf.hex'                                 ║\n"
+        else:
+            menu += "║   ● 'klipper.bin'                                     ║\n"
+
+        print(menu, end="")
+
+    def go_back(self, **kwargs) -> None:
+        from core.menus.advanced_menu import AdvancedMenu
+
+        AdvancedMenu().run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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]"
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = previous_menu
+
+    def set_options(self) -> None:
+        self.default_option = Option(method=self.go_back)
+
+    def print_menu(self) -> None:
+        line1 = "Reading the list of supported boards failed!"
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {Color.apply(line1, Color.RED):<62} ║
+            ║                                                       ║
+            ║ Make sure, that:                                      ║
+            ║ ● the folder '~/klipper' and all its content exist    ║
+            ║ ● the content of folder '~/klipper' is not currupted  ║
+            ║ ● the file '~/klipper/scripts/flash-sd.py' exist      ║
+            ║ ● your current user has access to those files/folders ║
+            ║                                                       ║
+            ║ If in doubt or this process continues to fail, please ║
+            ║ consider to download Klipper again.                   ║
+            """
+        )[1:]
+        print(menu, end="")
+
+    def go_back(self, **kwargs) -> None:
+        from core.menus.main_menu import MainMenu
+
+        MainMenu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

@@ -0,0 +1,177 @@
+# ======================================================================= #
+#  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 Tuple, Type
+
+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:
+        from components.klipper_firmware.menus.klipper_flash_menu import (
+            KlipperFlashMethodMenu,
+        )
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
+        )
+
+    def set_options(self) -> None:
+        pass
+
+    def print_menu(self) -> None:
+        subheader1 = Color.apply("Regular flashing method:", Color.CYAN)
+        subheader2 = Color.apply("Updating via SD-Card Update:", Color.CYAN)
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {subheader1:<62} ║
+            ║ The default method to flash controller boards which   ║
+            ║ are connected and updated over USB and not by placing ║
+            ║ a compiled firmware file onto an internal SD-Card.    ║
+            ║                                                       ║
+            ║ Common controllers that get flashed that way are:     ║
+            ║ - Arduino Mega 2560                                   ║
+            ║ - Fysetc F6 / S6 (used without a Display + SD-Slot)   ║
+            ║                                                       ║
+            ║ {subheader2:<62} ║
+            ║ Many popular controller boards ship with a bootloader ║
+            ║ capable of updating the firmware via SD-Card.         ║
+            ║ Choose this method if your controller board supports  ║
+            ║ this way of updating. This method ONLY works for up-  ║
+            ║ grading firmware. The initial flashing procedure must ║
+            ║ be done manually per the instructions that apply to   ║
+            ║ your controller board.                                ║
+            ║                                                       ║
+            ║ Common controllers that can be flashed that way are:  ║
+            ║ - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3    ║
+            ║ - Fysetc F6 / S6 (used with a Display + SD-Slot)      ║
+            ║ - Fysetc Spider                                       ║
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+
+# noinspection DuplicatedCode
+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:
+        from components.klipper_firmware.menus.klipper_flash_menu import (
+            KlipperFlashCommandMenu,
+        )
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
+        )
+
+    def set_options(self) -> None:
+        pass
+
+    def print_menu(self) -> None:
+        subheader1 = Color.apply("make flash:", Color.CYAN)
+        subheader2 = Color.apply("make serialflash:", Color.CYAN)
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {subheader1:<62} ║
+            ║ The default command to flash controller board, it     ║
+            ║ will detect selected microcontroller and use suitable ║
+            ║ tool for flashing it.                                 ║
+            ║                                                       ║
+            ║ {subheader2:<62} ║
+            ║ Special command to flash STM32 microcontrollers in    ║
+            ║ DFU mode but connected via serial. stm32flash command ║
+            ║ will be used internally.                              ║
+            ║                                                       ║
+            """
+        )[1:]
+        print(menu, end="")
+
+
+# noinspection DuplicatedCode
+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:
+        from components.klipper_firmware.menus.klipper_flash_menu import (
+            KlipperSelectMcuConnectionMenu,
+        )
+
+        self.previous_menu = (
+            previous_menu
+            if previous_menu is not None
+            else KlipperSelectMcuConnectionMenu
+        )
+
+    def set_options(self) -> None:
+        pass
+
+    def print_menu(self) -> None:
+        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"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {subheader1:<62} ║
+            ║ Selecting USB as the connection method will scan the  ║
+            ║ USB ports for connected controller boards. This will  ║
+            ║ be similar to the 'ls /dev/serial/by-id/*' command    ║
+            ║ suggested by the official Klipper documentation for   ║
+            ║ determining successfull USB connections!              ║
+            ║                                                       ║
+            ║ {subheader2:<62} ║
+            ║ Selecting UART as the connection method will list all ║
+            ║ possible UART serial ports. Note: This method ALWAYS  ║
+            ║ returns something as it seems impossible to determine ║
+            ║ if a valid Klipper controller board is connected or   ║
+            ║ not. Because of that, you MUST know which UART serial ║
+            ║ 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:]
+        print(menu, end="")

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -0,0 +1,484 @@
+# ======================================================================= #
+#  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
+import time
+from pathlib import Path
+from typing import Type
+
+from components.klipper_firmware.firmware_utils import (
+    find_firmware_file,
+    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,
+)
+from components.klipper_firmware.flash_options import (
+    ConnectionType,
+    FlashCommand,
+    FlashMethod,
+    FlashOptions,
+)
+from components.klipper_firmware.menus.klipper_flash_error_menu import (
+    KlipperNoBoardTypesErrorMenu,
+    KlipperNoFirmwareErrorMenu,
+)
+from components.klipper_firmware.menus.klipper_flash_help_menu import (
+    KlipperFlashCommandHelpMenu,
+    KlipperFlashMethodHelpMenu,
+    KlipperMcuConnectionHelpMenu,
+)
+from core.logger import DialogType, Logger
+from core.menus import FooterType, Option
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
+from utils.input_utils import get_number_input
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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
+        self.flash_options = FlashOptions()
+
+    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:
+        self.options = {
+            "1": Option(self.select_regular),
+            "2": Option(self.select_sdcard),
+        }
+
+    def print_menu(self) -> None:
+        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"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ Select the flash method for flashing the MCU.         ║
+            ║                                                       ║
+            ║ {subheader:<62} ║
+            ║ {subline1:<62} ║
+            ║ {subline2:<62} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) Regular flashing method                            ║
+            ║ 2) Updating via SD-Card Update                        ║
+            ╟───────────────────────────┬───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def select_regular(self, **kwargs):
+        self.flash_options.flash_method = FlashMethod.REGULAR
+        self.goto_next_menu()
+
+    def select_sdcard(self, **kwargs):
+        self.flash_options.flash_method = FlashMethod.SD_CARD
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        if find_firmware_file():
+            KlipperFlashCommandMenu(previous_menu=self.__class__).run()
+        else:
+            KlipperNoFirmwareErrorMenu().run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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
+        self.flash_options = FlashOptions()
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
+        )
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(self.select_flash),
+            "2": Option(self.select_serialflash),
+        }
+        self.default_option = Option(self.select_flash)
+
+    def print_menu(self) -> None:
+        menu = textwrap.dedent(
+            """
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) make flash (default)                               ║
+            ║ 2) make serialflash (stm32flash)                      ║
+            ╟───────────────────────────┬───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def select_flash(self, **kwargs):
+        self.flash_options.flash_command = FlashCommand.FLASH
+        self.goto_next_menu()
+
+    def select_serialflash(self, **kwargs):
+        self.flash_options.flash_command = FlashCommand.SERIAL_FLASH
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        KlipperSelectMcuConnectionMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuConnectionMenu(BaseMenu):
+    def __init__(
+        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
+        self.input_label_txt = "Select connection type"
+        self.footer_type = FooterType.BACK_HELP
+        self.flash_options = FlashOptions()
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
+        )
+
+    def set_options(self) -> None:
+        self.options = {
+            "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:
+        menu = textwrap.dedent(
+            """
+            ╟───────────────────────────────────────────────────────╢
+            ║ How is the controller board connected to the host?    ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) USB                                                ║
+            ║ 2) UART                                               ║
+            ║ 3) USB (DFU mode)                                     ║
+            ║ 4) USB (RP2040 mode)                                  ║
+            ╟───────────────────────────┬───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def select_usb(self, **kwargs):
+        self.flash_options.connection_type = ConnectionType.USB
+        self.get_mcu_list()
+
+    def select_dfu(self, **kwargs):
+        self.flash_options.connection_type = ConnectionType.UART
+        self.get_mcu_list()
+
+    def select_usb_dfu(self, **kwargs):
+        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
+
+        if conn_type is ConnectionType.USB:
+            Logger.print_status("Identifying MCU connected via USB ...")
+            self.flash_options.mcu_list = find_usb_device_by_id()
+        elif conn_type is ConnectionType.UART:
+            Logger.print_status("Identifying MCU possibly connected via UART ...")
+            self.flash_options.mcu_list = find_uart_device()
+        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!")
+            Logger.print_warn("Make sure they are connected and repeat this step.")
+
+        # if standalone is True, we only display the MCUs to the user and return
+        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}{Color.RST}")
+            time.sleep(3)
+            return
+
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        KlipperSelectMcuIdMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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"
+        self.footer_type = FooterType.BACK
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
+            previous_menu
+            if previous_menu is not None
+            else KlipperSelectMcuConnectionMenu
+        )
+
+    def set_options(self) -> None:
+        self.options = {
+            f"{i}": Option(self.flash_mcu, f"{i}") for i in range(len(self.mcu_list))
+        }
+
+    def print_menu(self) -> None:
+        header2 = f"[{Color.apply('List of detected MCUs', Color.CYAN)}]"
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ Make sure, to select the correct MCU!                 ║
+            ║ ONLY flash a firmware created for the respective MCU! ║
+            ║                                                       ║
+            ╟{header2:─^64}╢
+            ║                                                       ║
+            """
+        )[1:]
+
+        for i, mcu in enumerate(self.mcu_list):
+            mcu = mcu.split("/")[-1]
+            menu += f"║ {i}) {Color.apply(f'{mcu:<51}', Color.CYAN)}║\n"
+
+        menu += textwrap.dedent(
+            """
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def flash_mcu(self, **kwargs):
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
+
+            index = int(index)
+            selected_mcu = self.mcu_list[index]
+            self.flash_options.selected_mcu = selected_mcu
+
+            if self.flash_options.flash_method == FlashMethod.SD_CARD:
+                KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
+            elif self.flash_options.flash_method == FlashMethod.REGULAR:
+                KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Flashing failed!")
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectSDFlashBoardMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        self.flash_options = FlashOptions()
+        self.available_boards = get_sd_flash_board_list()
+        self.input_label_txt = "Select board type"
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperSelectMcuIdMenu
+        )
+
+    def set_options(self) -> None:
+        self.options = {
+            f"{i}": Option(self.board_select, f"{i}")
+            for i in range(len(self.available_boards))
+        }
+
+    def print_menu(self) -> None:
+        if len(self.available_boards) < 1:
+            KlipperNoBoardTypesErrorMenu().run()
+        else:
+            menu = textwrap.dedent(
+                """
+                ║ Please select the type of board that corresponds to   ║
+                ║ the currently selected MCU ID you chose before.       ║
+                ║                                                       ║
+                ║ The following boards are currently supported:         ║
+                ╟───────────────────────────────────────────────────────╢
+                """
+            )[1:]
+
+            for i, board in enumerate(self.available_boards):
+                line = f" {i}) {board}"
+                menu += f"║{line:<55}║\n"
+            menu += "╟───────────────────────────────────────────────────────╢"
+            print(menu, end="")
+
+    def board_select(self, **kwargs):
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
+
+            index = int(index)
+            self.flash_options.selected_board = self.available_boards[index]
+            self.baudrate_select()
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Board selection failed!")
+
+    def baudrate_select(self, **kwargs):
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            [
+                "If your board is flashed with firmware that connects "
+                "at a custom baud rate, please change it now.",
+                "\n\n",
+                "If you are unsure, stick to the default 250000!",
+            ],
+        )
+        self.flash_options.selected_baudrate = get_number_input(
+            question="Please set the baud rate",
+            default=250000,
+            min_value=0,
+            allow_go_back=True,
+        )
+        KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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)"
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_options(self) -> None:
+        self.options = {
+            "y": Option(self.execute_flash),
+            "n": Option(self.abort_process),
+        }
+
+        self.default_option = Option(self.execute_flash)
+
+    def print_menu(self) -> None:
+        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
+        kconfig = Path(self.flash_options.selected_kconfig).name
+        color = Color.CYAN
+        subheader = f"[{Color.apply('Overview', color)}]"
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ Before contuining the flashing process, please check  ║
+            ║ if all parameters were set correctly! Once you made   ║
+            ║ sure everything is correct, start the process. If any ║
+            ║ parameter needs to be changed, you can go back (B)    ║
+            ║ step by step or abort and start from the beginning.   ║
+            ║{subheader:─^64}║
+            ║                                                       ║
+            """
+        )[1:]
+
+        menu += textwrap.dedent(
+            f"""
+            ║ 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.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:]
+
+        menu += textwrap.dedent(
+            """
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  Y) Start flash process                               ║
+            ║  N) Abort - Return to Advanced Menu                   ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def execute_flash(self, **kwargs):
+        start_flash_process(self.flash_options)
+        Logger.print_info("Returning to MCU Flash Menu in 5 seconds ...")
+        time.sleep(5)
+        KlipperFlashMethodMenu().run()
+
+    def abort_process(self, **kwargs):
+        from core.menus.advanced_menu import AdvancedMenu
+
+        AdvancedMenu().run()

kiauh/components/klipperscreen/__init__.py

@@ -0,0 +1,34 @@
+# ======================================================================= #
+#  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 pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
+
+# repo
+KLIPPERSCREEN_REPO = "https://github.com/KlipperScreen/KlipperScreen.git"
+
+# names
+KLIPPERSCREEN_SERVICE_NAME = "KlipperScreen.service"
+KLIPPERSCREEN_UPDATER_SECTION_NAME = "update_manager KlipperScreen"
+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(
+    "scripts/KlipperScreen-requirements.txt"
+)
+KLIPPERSCREEN_INSTALL_SCRIPT = KLIPPERSCREEN_DIR.joinpath(
+    "scripts/KlipperScreen-install.sh"
+)
+KLIPPERSCREEN_SERVICE_FILE = SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)

kiauh/components/klipperscreen/klipperscreen.py

@@ -0,0 +1,206 @@
+# ======================================================================= #
+#  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 shutil
+from pathlib import Path
+from subprocess import CalledProcessError, run
+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,
+    KLIPPERSCREEN_LOG_NAME,
+    KLIPPERSCREEN_REPO,
+    KLIPPERSCREEN_REQ_FILE,
+    KLIPPERSCREEN_SERVICE_FILE,
+    KLIPPERSCREEN_SERVICE_NAME,
+    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.settings.kiauh_settings import KiauhSettings
+from core.types.component_status import ComponentStatus
+from utils.common import (
+    check_install_dependencies,
+    get_install_status,
+)
+from utils.config_utils import add_config_section, remove_config_section
+from utils.fs_utils import remove_with_sudo
+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 (
+    check_python_version,
+    cmd_sysctl_service,
+    install_python_requirements,
+    remove_system_service,
+)
+
+
+def install_klipperscreen() -> None:
+    Logger.print_status("Installing KlipperScreen ...")
+
+    if not check_python_version(3, 7):
+        return
+
+    mr_instances = get_instances(Moonraker)
+    if not mr_instances:
+        Logger.print_dialog(
+            DialogType.WARNING,
+            [
+                "Moonraker not found! KlipperScreen will not properly work "
+                "without a working Moonraker installation.",
+                "\n\n",
+                "KlipperScreens update manager configuration for Moonraker "
+                "will not be added to any moonraker.conf.",
+            ],
+        )
+        if not get_confirm(
+            "Continue KlipperScreen installation?",
+            default_choice=False,
+            allow_go_back=True,
+        ):
+            return
+
+    check_install_dependencies()
+
+    git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
+
+    try:
+        run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
+        if mr_instances:
+            patch_klipperscreen_update_manager(mr_instances)
+            InstanceManager.restart_all(mr_instances)
+        else:
+            Logger.print_info(
+                "Moonraker is not installed! Cannot add "
+                "KlipperScreen to update manager!"
+            )
+        Logger.print_ok("KlipperScreen successfully installed!")
+    except CalledProcessError as e:
+        Logger.print_error(f"Error installing KlipperScreen:\n{e}")
+        return
+
+
+def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
+    add_config_section(
+        section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
+        instances=instances,
+        options=[
+            ("type", "git_repo"),
+            ("path", KLIPPERSCREEN_DIR.as_posix()),
+            ("origin", KLIPPERSCREEN_REPO),
+            ("managed_services", "KlipperScreen"),
+            ("env", f"{KLIPPERSCREEN_ENV_DIR}/bin/python"),
+            ("requirements", KLIPPERSCREEN_REQ_FILE.as_posix()),
+            ("install_script", KLIPPERSCREEN_INSTALL_SCRIPT.as_posix()),
+        ],
+    )
+
+
+def update_klipperscreen() -> None:
+    if not KLIPPERSCREEN_DIR.exists():
+        Logger.print_info("KlipperScreen does not seem to be installed! Skipping ...")
+        return
+
+    try:
+        Logger.print_status("Updating KlipperScreen ...")
+
+        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "stop")
+
+        settings = KiauhSettings()
+        if settings.kiauh.backup_before_update:
+            backup_klipperscreen_dir()
+
+        git_pull_wrapper(KLIPPERSCREEN_DIR)
+
+        install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
+
+        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "start")
+
+        Logger.print_ok("KlipperScreen updated successfully.", end="\n\n")
+    except CalledProcessError as e:
+        Logger.print_error(f"Error updating KlipperScreen:\n{e}")
+        return
+
+
+def get_klipperscreen_status() -> ComponentStatus:
+    return get_install_status(
+        KLIPPERSCREEN_DIR,
+        KLIPPERSCREEN_ENV_DIR,
+        files=[SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)],
+    )
+
+
+def remove_klipperscreen() -> None:
+    Logger.print_status("Removing KlipperScreen ...")
+    try:
+        if KLIPPERSCREEN_DIR.exists():
+            Logger.print_status("Removing KlipperScreen directory ...")
+            shutil.rmtree(KLIPPERSCREEN_DIR)
+            Logger.print_ok("KlipperScreen directory successfully removed!")
+        else:
+            Logger.print_warn("KlipperScreen directory not found!")
+
+        if KLIPPERSCREEN_ENV_DIR.exists():
+            Logger.print_status("Removing KlipperScreen environment ...")
+            shutil.rmtree(KLIPPERSCREEN_ENV_DIR)
+            Logger.print_ok("KlipperScreen environment successfully removed!")
+        else:
+            Logger.print_warn("KlipperScreen environment not found!")
+
+        if KLIPPERSCREEN_SERVICE_FILE.exists():
+            remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
+
+        logfile = Path(f"/tmp/{KLIPPERSCREEN_LOG_NAME}")
+        if logfile.exists():
+            Logger.print_status("Removing KlipperScreen log file ...")
+            remove_with_sudo(logfile)
+            Logger.print_ok("KlipperScreen log file successfully removed!")
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+        for instance in kl_instances:
+            logfile = instance.base.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
+            if logfile.exists():
+                Logger.print_status(f"Removing {logfile} ...")
+                Path(logfile).unlink()
+                Logger.print_ok(f"{logfile} successfully removed!")
+
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
+        if mr_instances:
+            Logger.print_status("Removing KlipperScreen from update manager ...")
+            remove_config_section("update_manager KlipperScreen", mr_instances)
+            Logger.print_ok("KlipperScreen successfully removed from update manager!")
+
+        Logger.print_ok("KlipperScreen successfully removed!")
+
+    except Exception as e:
+        Logger.print_error(f"Error removing KlipperScreen:\n{e}")
+
+
+def backup_klipperscreen_dir() -> None:
+    bm = BackupManager()
+    bm.backup_directory(
+        KLIPPERSCREEN_DIR.name,
+        source=KLIPPERSCREEN_DIR,
+        target=KLIPPERSCREEN_BACKUP_DIR,
+    )
+    bm.backup_directory(
+        KLIPPERSCREEN_ENV_DIR.name,
+        source=KLIPPERSCREEN_ENV_DIR,
+        target=KLIPPERSCREEN_BACKUP_DIR,
+    )

kiauh/components/log_uploads/__init__.py

@@ -0,0 +1,14 @@
+# ======================================================================= #
+#  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 pathlib import Path
+from typing import Dict, Literal, Union
+
+FileKey = Literal["filepath", "display_name"]
+LogFile = Dict[FileKey, Union[str, Path]]

kiauh/components/log_uploads/log_upload_utils.py

@@ -0,0 +1,55 @@
+# ======================================================================= #
+#  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 urllib.request
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.log_uploads import LogFile
+from core.logger import Logger
+from utils.instance_utils import get_instances
+
+
+def get_logfile_list() -> List[LogFile]:
+    log_dirs: List[Path] = [
+        instance.base.log_dir for instance in get_instances(Klipper)
+    ]
+
+    logfiles: List[LogFile] = []
+    for _dir in log_dirs:
+        for f in _dir.iterdir():
+            logfiles.append({"filepath": f, "display_name": get_display_name(f)})
+
+    return logfiles
+
+
+def get_display_name(filepath: Path) -> str:
+    printer = " ".join(filepath.parts[-3].split("_")[:-1])
+    name = filepath.name
+
+    return f"{printer}: {name}"
+
+
+def upload_logfile(logfile: LogFile) -> None:
+    file = logfile.get("filepath")
+    name = logfile.get("display_name")
+    Logger.print_status(f"Uploading the following logfile from {name} ...")
+
+    with open(file, "rb") as f:
+        headers = {"x-random": ""}
+        req = urllib.request.Request("http://paste.c-net.org/", headers=headers, data=f)
+        try:
+            response = urllib.request.urlopen(req)
+            link = response.read().decode("utf-8")
+            Logger.print_ok("Upload successful! Access it via the following link:")
+            Logger.print_ok(f">>>> {link}", False)
+        except Exception as e:
+            Logger.print_error("Uploading logfile failed!")
+            Logger.print_error(str(e))

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -0,0 +1,67 @@
+# ======================================================================= #
+#  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.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
+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()
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            f"{index}": Option(self.upload, opt_index=f"{index}")
+            for index in range(len(self.logfile_list))
+        }
+
+    def print_menu(self) -> None:
+        menu = textwrap.dedent(
+            """
+            ╟───────────────────────────────────────────────────────╢
+            ║ You can select the following logfiles for uploading:  ║
+            ║                                                       ║
+            """
+        )[1:]
+
+        for logfile in enumerate(self.logfile_list):
+            line = f"{logfile[0]}) {logfile[1].get('display_name')}"
+            menu += f"║ {line:<54}║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+
+        print(menu, end="")
+
+    def upload(self, **kwargs):
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
+
+            index = int(index)
+            upload_logfile(self.logfile_list[index])
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Log upload failed!")

kiauh/components/moonraker/__init__.py

@@ -0,0 +1,47 @@
+# ======================================================================= #
+#  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 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"
+MOONRAKER_SERVICE_NAME = "moonraker.service"
+MOONRAKER_DEFAULT_PORT = 7125
+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")
+MOONRAKER_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-requirements.txt")
+MOONRAKER_SPEEDUPS_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-speedups.txt")
+MOONRAKER_DEPS_JSON_FILE = MOONRAKER_DIR.joinpath("scripts/system-dependencies.json")
+# introduced due to
+# https://github.com/Arksine/moonraker/issues/349
+# https://github.com/Arksine/moonraker/pull/346
+POLKIT_LEGACY_FILE = Path("/etc/polkit-1/localauthority/50-local.d/10-moonraker.pkla")
+POLKIT_FILE = Path("/etc/polkit-1/rules.d/moonraker.rules")
+POLKIT_USR_FILE = Path("/usr/share/polkit-1/rules.d/moonraker.rules")
+POLKIT_SCRIPT = MOONRAKER_DIR.joinpath("scripts/set-policykit-rules.sh")
+MOONRAKER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_SERVICE_NAME}")
+MOONRAKER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_ENV_FILE_NAME}")
+
+
+EXIT_MOONRAKER_SETUP = "Exiting Moonraker setup ..."

kiauh/components/moonraker/assets/moonraker.conf

@@ -0,0 +1,30 @@
+[server]
+host: 0.0.0.0
+port: %PORT%
+klippy_uds_address: %UDS%
+
+[authorization]
+trusted_clients:
+    10.0.0.0/8
+    127.0.0.0/8
+    169.254.0.0/16
+    172.16.0.0/12
+    192.168.0.0/16
+    FC00::/7
+    FE80::/10
+    ::1/128
+cors_domains:
+    *.lan
+    *.local
+    *://localhost
+    *://localhost:*
+    *://my.mainsail.xyz
+    *://app.fluidd.xyz
+
+[octoprint_compat]
+
+[history]
+
+[update_manager]
+channel: dev
+refresh_interval: 168

kiauh/components/moonraker/assets/moonraker.env

@@ -0,0 +1 @@
+MOONRAKER_ARGS="%MOONRAKER_DIR%/moonraker/moonraker.py -d %PRINTER_DATA%"

kiauh/components/moonraker/assets/moonraker.service

@@ -0,0 +1,19 @@
+[Unit]
+Description=API Server for Klipper SV1
+Documentation=https://moonraker.readthedocs.io/
+Requires=network-online.target
+After=network-online.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+SupplementaryGroups=moonraker-admin
+RemainAfterExit=yes
+WorkingDirectory=%MOONRAKER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $MOONRAKER_ARGS
+Restart=always
+RestartSec=10

kiauh/components/moonraker/menus/moonraker_remove_menu.py

@@ -0,0 +1,110 @@
+# ======================================================================= #
+#  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.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.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
+
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "a": Option(method=self.toggle_all),
+            "1": Option(method=self.toggle_remove_moonraker_service),
+            "2": Option(method=self.toggle_remove_moonraker_dir),
+            "3": Option(method=self.toggle_remove_moonraker_env),
+            "4": Option(method=self.toggle_remove_moonraker_polkit),
+            "c": Option(method=self.run_removal_process),
+        }
+
+    def print_menu(self) -> None:
+        checked = f"[{Color.apply('x', Color.CYAN)}]"
+        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"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ Enter a number and hit enter to select / deselect     ║
+            ║ the specific option for removal.                      ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  a) {sel_state:49} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  1) {o1} Remove Service                                ║
+            ║  2) {o2} Remove Local Repository                       ║
+            ║  3) {o3} Remove Python Environment                     ║
+            ║  4) {o4} Remove Policy Kit Rules                       ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  C) Continue                                          ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        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.rm_svc = not self.rm_svc
+
+    def toggle_remove_moonraker_dir(self, **kwargs) -> None:
+        self.rm_dir = not self.rm_dir
+
+    def toggle_remove_moonraker_env(self, **kwargs) -> None:
+        self.rm_env = not self.rm_env
+
+    def toggle_remove_moonraker_polkit(self, **kwargs) -> None:
+        self.rm_pk = not self.rm_pk
+
+    def run_removal_process(self, **kwargs) -> None:
+        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
+
+        self.mrsvc.remove(self.rm_svc, self.rm_dir, self.rm_env, self.rm_pk)
+
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
+        self.rm_pk = False

kiauh/components/moonraker/moonraker.py

@@ -0,0 +1,146 @@
+# ======================================================================= #
+#  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 pathlib import Path
+from subprocess import CalledProcessError
+
+from components.klipper.klipper import Klipper
+from components.moonraker import (
+    MOONRAKER_CFG_NAME,
+    MOONRAKER_DIR,
+    MOONRAKER_ENV_DIR,
+    MOONRAKER_ENV_FILE_NAME,
+    MOONRAKER_ENV_FILE_TEMPLATE,
+    MOONRAKER_LOG_NAME,
+    MOONRAKER_SERVICE_TEMPLATE,
+)
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
+
+
+# noinspection PyMethodMayBeStatic
+@dataclass
+class Moonraker:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name: str = MOONRAKER_LOG_NAME
+    moonraker_dir: Path = MOONRAKER_DIR
+    env_dir: Path = MOONRAKER_ENV_DIR
+    data_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+    env_file: Path = field(init=False)
+    backup_dir: Path = field(init=False)
+    certs_dir: Path = field(init=False)
+    db_dir: Path = field(init=False)
+    port: int | None = field(init=False)
+
+    def __post_init__(self):
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        self.base.log_file_name = self.log_file_name
+
+        self.service_file_path: Path = get_service_file_path(Moonraker, self.suffix)
+        self.data_dir: Path = self.base.data_dir
+        self.cfg_file: Path = self.base.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
+        self.env_file: Path = self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME)
+        self.backup_dir: Path = self.base.data_dir.joinpath("backup")
+        self.certs_dir: Path = self.base.data_dir.joinpath("certs")
+        self.db_dir: Path = self.base.data_dir.joinpath("database")
+        self.port: int | None = self._get_port()
+
+    def create(self) -> None:
+        from utils.sys_utils import create_env_file, create_service_file
+
+        Logger.print_status("Creating new Moonraker Instance ...")
+
+        try:
+            create_folders(self.base.base_folders)
+
+            create_service_file(
+                name=self.service_file_path.name,
+                content=self._prep_service_file_content(),
+            )
+            create_env_file(
+                path=self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
+                content=self._prep_env_file_content(),
+            )
+
+        except CalledProcessError as e:
+            Logger.print_error(f"Error creating instance: {e}")
+            raise
+        except OSError as e:
+            Logger.print_error(f"Error creating env file: {e}")
+            raise
+
+    def _prep_service_file_content(self) -> str:
+        template = MOONRAKER_SERVICE_TEMPLATE
+
+        try:
+            with open(template, "r") as template_file:
+                template_content = template_file.read()
+        except FileNotFoundError:
+            Logger.print_error(f"Unable to open {template} - File not found")
+            raise
+
+        service_content = template_content.replace(
+            "%USER%",
+            CURRENT_USER,
+        )
+        service_content = service_content.replace(
+            "%MOONRAKER_DIR%",
+            self.moonraker_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV%",
+            self.env_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV_FILE%",
+            self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
+        )
+        return service_content
+
+    def _prep_env_file_content(self) -> str:
+        template = MOONRAKER_ENV_FILE_TEMPLATE
+
+        try:
+            with open(template, "r") as env_file:
+                env_template_file_content = env_file.read()
+        except FileNotFoundError:
+            Logger.print_error(f"Unable to open {template} - File not found")
+            raise
+
+        env_file_content = env_template_file_content.replace(
+            "%MOONRAKER_DIR%",
+            self.moonraker_dir.as_posix(),
+        )
+        env_file_content = env_file_content.replace(
+            "%PRINTER_DATA%",
+            self.base.data_dir.as_posix(),
+        )
+
+        return env_file_content
+
+    def _get_port(self) -> int | None:
+        if not self.cfg_file or not self.cfg_file.is_file():
+            return None
+
+        scp = SimpleConfigParser()
+        scp.read_file(self.cfg_file)
+        port: int | None = scp.getint("server", "port", fallback=None)
+
+        return port

kiauh/components/moonraker/moonraker_dialogs.py

@@ -0,0 +1,75 @@
+# ======================================================================= #
+#  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 textwrap
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.menus.base_menu import print_back_footer
+from core.types.color import Color
+
+
+def print_moonraker_overview(
+    klipper_instances: List[Klipper],
+    moonraker_instances: List[Moonraker],
+    show_index=False,
+    show_select_all=False,
+):
+    headline = Color.apply("The following instances were found:", Color.GREEN)
+    dialog = textwrap.dedent(
+        f"""
+        ╔═══════════════════════════════════════════════════════╗
+        ║{headline:^64}║
+        ╟───────────────────────────────────────────────────────╢
+        """
+    )[1:]
+
+    if show_select_all:
+        select_all = Color.apply("a) Select all", Color.YELLOW)
+        dialog += f"║ {select_all:<63}║\n"
+        dialog += "║                                                       ║\n"
+
+    instance_map = {
+        k.service_file_path.stem: (
+            k.service_file_path.stem.replace("klipper", "moonraker")
+            if k.suffix in [m.suffix for m in moonraker_instances]
+            else ""
+        )
+        for k in klipper_instances
+    }
+
+    for i, k in enumerate(instance_map):
+        mr_name = instance_map.get(k)
+        m = f"<-> {mr_name}" if mr_name != "" else ""
+        line = Color.apply(f"{f'{i + 1})' if show_index else '●'} {k} {m}", Color.CYAN)
+        dialog += f"║ {line:<63}║\n"
+
+    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"""
+        ║                                                       ║
+        ╟───────────────────────────────────────────────────────╢
+        ║ {warn_l1:<63}║
+        ║ {warn_l2:<63}║
+        ║ {warn_l3:<63}║
+        ╟───────────────────────────────────────────────────────╢
+        """
+    )[1:]
+
+    dialog += warning
+
+    print(dialog, end="")
+    print_back_footer()

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,173 @@
+# ======================================================================= #
+#  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)
+
+    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 == "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

@@ -0,0 +1,196 @@
+# ======================================================================= #
+#  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.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+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,
+)
+
+
+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],
+    clients: Optional[List[BaseWebClient]] = None,
+) -> None:
+    Logger.print_status(f"Creating example moonraker.conf in '{instance.base.cfg_dir}'")
+    if instance.cfg_file.is_file():
+        Logger.print_info(f"'{instance.cfg_file}' already exists.")
+        return
+
+    source = MODULE_PATH.joinpath("assets/moonraker.conf")
+    target = instance.cfg_file
+    try:
+        shutil.copy(source, target)
+    except OSError as e:
+        Logger.print_error(f"Unable to create example moonraker.conf:\n{e}")
+        return
+
+    ports = [
+        ports_map.get(instance)
+        for instance in ports_map
+        if ports_map.get(instance) is not None
+    ]
+    if ports_map.get(instance.suffix) is None:
+        # this could be improved to not increment the max value of the ports list and assign it as the port
+        # as it can lead to situation where the port for e.g. instance moonraker-2 becomes 7128 if the port
+        # of moonraker-1 is 7125 and moonraker-3 is 7127 and there are moonraker.conf files for moonraker-1
+        # and moonraker-3 already. though, there does not seem to be a very reliable way of always assigning
+        # the correct port to each instance and the user will likely be required to correct the value manually.
+        port = max(ports) + 1 if ports else MOONRAKER_DEFAULT_PORT
+    else:
+        port = ports_map.get(instance.suffix)
+
+    ports_map[instance.suffix] = port
+
+    ip = get_ipv4_addr().split(".")[:2]
+    ip.extend(["0", "0/16"])
+    uds = instance.base.comms_dir.joinpath("klippy.sock")
+
+    scp = SimpleConfigParser()
+    scp.read_file(target)
+    trusted_clients: List[str] = [
+        f"    {'.'.join(ip)}\n",
+        *scp.getvals("authorization", "trusted_clients"),
+    ]
+
+    scp.set_option("server", "port", str(port))
+    scp.set_option("server", "klippy_uds_address", str(uds))
+    scp.set_option("authorization", "trusted_clients", trusted_clients)
+
+    # add existing client and client configs in the update section
+    if clients is not None and len(clients) > 0:
+        for c in clients:
+            # client part
+            c_section = f"update_manager {c.name}"
+            c_options = [
+                ("type", "web"),
+                ("channel", "stable"),
+                ("repo", c.repo_path),
+                ("path", c.client_dir),
+            ]
+            scp.add_section(section=c_section)
+            for option in c_options:
+                scp.set_option(c_section, option[0], option[1])
+
+            # client config part
+            c_config = c.client_config
+            if c_config.config_dir.exists():
+                c_config_section = f"update_manager {c_config.name}"
+                c_config_options = [
+                    ("type", "git_repo"),
+                    ("primary_branch", "master"),
+                    ("path", c_config.config_dir),
+                    ("origin", c_config.repo_url),
+                    ("managed_services", "klipper"),
+                ]
+                scp.add_section(section=c_config_section)
+                for option in c_config_options:
+                    scp.set_option(c_config_section, option[0], option[1])
+
+    scp.write_file(target)
+    Logger.print_ok(f"Example moonraker.conf created in '{instance.base.cfg_dir}'")
+
+
+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
+    )
+
+
+def backup_moonraker_db_dir() -> None:
+    instances: List[Moonraker] = get_instances(Moonraker)
+    bm = BackupManager()
+
+    for instance in instances:
+        name = f"database-{instance.data_dir.name}"
+        bm.backup_directory(
+            name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
+        )
+
+
+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

@@ -0,0 +1,12 @@
+# ======================================================================= #
+#  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 pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent

kiauh/components/webui_client/assets/common_vars.conf

@@ -0,0 +1,6 @@
+# /etc/nginx/conf.d/common_vars.conf
+
+map $http_upgrade $connection_upgrade {
+    default upgrade;
+    '' close;
+}

kiauh/components/webui_client/assets/nginx_cfg

@@ -0,0 +1,95 @@
+server {
+    listen %PORT%;
+    # uncomment the next line to activate IPv6
+    # listen [::]:%PORT%;
+
+    access_log /var/log/nginx/%NAME%-access.log;
+    error_log /var/log/nginx/%NAME%-error.log;
+
+    # disable this section on smaller hardware like a pi zero
+    gzip on;
+    gzip_vary on;
+    gzip_proxied any;
+    gzip_proxied expired no-cache no-store private auth;
+    gzip_comp_level 4;
+    gzip_buffers 16 8k;
+    gzip_http_version 1.1;
+    gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
+
+    # web_path from %NAME% static files
+    root %ROOT_DIR%;
+
+    index index.html;
+    server_name _;
+
+    # disable max upload size checks
+    client_max_body_size 0;
+
+    # disable proxy request buffering
+    proxy_request_buffering off;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+    }
+
+    location = /index.html {
+        add_header Cache-Control "no-store, no-cache, must-revalidate";
+    }
+
+    location /websocket {
+        proxy_pass http://apiserver/websocket;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_read_timeout 86400;
+    }
+
+    location ~ ^/(printer|api|access|machine|server)/ {
+        proxy_pass http://apiserver$request_uri;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Scheme $scheme;
+    }
+
+    location /webcam/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer1/;
+    }
+
+    location /webcam2/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer2/;
+    }
+
+    location /webcam3/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer3/;
+    }
+
+    location /webcam4/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer4/;
+    }
+}

kiauh/components/webui_client/assets/upstreams.conf

@@ -0,0 +1,25 @@
+# /etc/nginx/conf.d/upstreams.conf
+upstream apiserver {
+    ip_hash;
+    server 127.0.0.1:7125;
+}
+
+upstream mjpgstreamer1 {
+    ip_hash;
+    server 127.0.0.1:8080;
+}
+
+upstream mjpgstreamer2 {
+    ip_hash;
+    server 127.0.0.1:8081;
+}
+
+upstream mjpgstreamer3 {
+    ip_hash;
+    server 127.0.0.1:8082;
+}
+
+upstream mjpgstreamer4 {
+    ip_hash;
+    server 127.0.0.1:8083;
+}

kiauh/components/webui_client/base_data.py

@@ -0,0 +1,57 @@
+# ======================================================================= #
+#  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 abc import ABC
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+
+
+class WebClientType(Enum):
+    MAINSAIL: str = "mainsail"
+    FLUIDD: str = "fluidd"
+
+
+class WebClientConfigType(Enum):
+    MAINSAIL: str = "mainsail-config"
+    FLUIDD: str = "fluidd-config"
+
+
+@dataclass()
+class BaseWebClient(ABC):
+    """Base class for webclient data"""
+
+    client: WebClientType
+    name: str
+    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
+
+
+@dataclass()
+class BaseWebClientConfig(ABC):
+    """Base class for webclient config data"""
+
+    client_config: WebClientConfigType
+    name: str
+    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

@@ -0,0 +1,91 @@
+# ======================================================================= #
+#  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 typing import List
+
+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.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
+
+
+def run_client_config_removal(
+    client_config: BaseWebClientConfig,
+    kl_instances: List[Klipper],
+    mr_instances: List[Moonraker],
+) -> 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")
+
+    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

@@ -0,0 +1,126 @@
+# ======================================================================= #
+#  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
+import subprocess
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import BaseWebClient, BaseWebClientConfig
+from components.webui_client.client_dialogs import (
+    print_client_already_installed_dialog,
+)
+from components.webui_client.client_utils import (
+    backup_client_config_data,
+    detect_client_cfg_conflict,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+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
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+
+
+def install_client_config(client_data: BaseWebClient, cfg_backup=True) -> None:
+    client_config: BaseWebClientConfig = client_data.client_config
+    display_name = client_config.display_name
+
+    if detect_client_cfg_conflict(client_data):
+        Logger.print_info("Another Client-Config is already installed! Skipped ...")
+        return
+
+    if client_config.config_dir.exists():
+        print_client_already_installed_dialog(display_name)
+        if get_confirm(f"Re-install {display_name}?", allow_go_back=True):
+            shutil.rmtree(client_config.config_dir)
+        else:
+            return
+
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    kl_instances = get_instances(Klipper)
+
+    try:
+        download_client_config(client_config)
+        create_client_config_symlink(client_config, kl_instances)
+
+        if cfg_backup:
+            backup_printer_config_dir()
+
+        add_config_section(
+            section=f"update_manager {client_config.name}",
+            instances=mr_instances,
+            options=[
+                ("type", "git_repo"),
+                ("primary_branch", "master"),
+                ("path", str(client_config.config_dir)),
+                ("origin", str(client_config.repo_url)),
+                ("managed_services", "klipper"),
+            ],
+        )
+        add_config_section_at_top(client_config.config_section, kl_instances)
+        InstanceManager.restart_all(kl_instances)
+
+    except Exception as e:
+        Logger.print_error(f"{display_name} installation failed!\n{e}")
+        return
+
+    Logger.print_ok(f"{display_name} installation complete!", start="\n")
+
+
+def download_client_config(client_config: BaseWebClientConfig) -> None:
+    try:
+        Logger.print_status(f"Downloading {client_config.display_name} ...")
+        repo = client_config.repo_url
+        target_dir = client_config.config_dir
+        git_clone_wrapper(repo, target_dir)
+    except Exception:
+        Logger.print_error(f"Downloading {client_config.display_name} failed!")
+        raise
+
+
+def update_client_config(client: BaseWebClient) -> None:
+    client_config: BaseWebClientConfig = client.client_config
+
+    Logger.print_status(f"Updating {client_config.display_name} ...")
+
+    if not client_config.config_dir.exists():
+        Logger.print_info(
+            f"Unable to update {client_config.display_name}. Directory does not exist! Skipping ..."
+        )
+        return
+
+    settings = KiauhSettings()
+    if settings.kiauh.backup_before_update:
+        backup_client_config_data(client)
+
+    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!")
+
+
+def create_client_config_symlink(
+    client_config: BaseWebClientConfig, klipper_instances: List[Klipper]
+) -> None:
+    for instance in klipper_instances:
+        Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
+        source = Path(client_config.config_dir, client_config.config_filename)
+        target = instance.base.cfg_dir
+        Logger.print_status(f"Linking {source} to {target}")
+        try:
+            create_symlink(source, target)
+        except subprocess.CalledProcessError:
+            Logger.print_error("Creating symlink failed!")

kiauh/components/webui_client/client_dialogs.py

@@ -0,0 +1,93 @@
+# ======================================================================= #
+#  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 typing import List
+
+from components.webui_client.base_data import BaseWebClient
+from core.logger import DialogType, Logger
+
+
+def print_moonraker_not_found_dialog(name: str) -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "No local Moonraker installation was found!",
+            "\n\n",
+            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 "
+            f"another machine in your network. Otherwise {name} will NOT work "
+            "correctly.",
+        ],
+    )
+
+
+def print_client_already_installed_dialog(name: str) -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            f"{name} seems to be already installed!",
+            f"If you continue, your current {name} installation will be overwritten.",
+        ],
+    )
+
+
+def print_client_port_select_dialog(
+    name: str, port: int, ports_in_use: List[int]
+) -> None:
+    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 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
+    url = client.client_config.repo_url.replace(".git", "")
+    Logger.print_dialog(
+        DialogType.INFO,
+        [
+            f"It is recommended to use special macros in order to have {name} fully "
+            f"functional and working.",
+            "\n\n",
+            f"The recommended macros for {name} can be seen here:",
+            url,
+            "\n\n",
+            "If you already use these macros skip this step. Otherwise you should "
+            "consider to answer with 'Y' to download the recommended macros.",
+        ],
+    )
+
+
+def print_ipv6_warning_dialog() -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "It looks like IPv6 is enabled on this system!",
+            "This may cause issues with the installation of NGINX in the following "
+            "steps! It is recommended to disable IPv6 on your system to avoid this issue.",
+            "\n\n",
+            "If you think this warning is a false alarm, and you are sure that "
+            "IPv6 is disabled, you can continue with the installation.",
+        ],
+    )

kiauh/components/webui_client/client_remove.py

@@ -0,0 +1,112 @@
+# ======================================================================= #
+#  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 typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import (
+    BaseWebClient,
+)
+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.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,
+    run_remove_routines,
+)
+from utils.instance_utils import get_instances
+
+
+def run_client_removal(
+    client: BaseWebClient,
+    remove_client: bool,
+    remove_client_cfg: bool,
+    backup_config: bool,
+) -> 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()
+        if bm.backup_file(client.config_file):
+            completion_msg.text.append(f"● {client.config_file.name} backup created")
+
+    if remove_client:
+        client_name = client.name
+        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")
+
+        section = f"update_manager {client_name}"
+        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:
+        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) -> bool:
+    Logger.print_status(f"Removing {client.display_name} ...")
+    return run_remove_routines(client.client_dir)
+
+
+def remove_client_nginx_config(name: str) -> bool:
+    Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
+    return remove_with_sudo(
+        [
+            NGINX_SITES_AVAILABLE.joinpath(name),
+            NGINX_SITES_ENABLED.joinpath(name),
+        ]
+    )
+
+
+def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> bool:
+    Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
+
+    files = [client.nginx_access_log, client.nginx_error_log]
+    if instances:
+        for instance in instances:
+            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

@@ -0,0 +1,187 @@
+# ======================================================================= #
+#  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 shutil
+import tempfile
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client import MODULE_PATH
+from components.webui_client.base_data import (
+    BaseWebClient,
+    BaseWebClientConfig,
+    WebClientType,
+)
+from components.webui_client.client_config.client_config_setup import (
+    install_client_config,
+)
+from components.webui_client.client_dialogs import (
+    print_install_client_config_dialog,
+    print_moonraker_not_found_dialog,
+)
+from components.webui_client.client_utils import (
+    copy_common_vars_nginx_cfg,
+    copy_upstream_nginx_cfg,
+    create_nginx_cfg,
+    detect_client_cfg_conflict,
+    enable_mainsail_remotemode,
+    get_client_port_selection,
+    symlink_webui_nginx_log,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
+from utils.common import backup_printer_config_dir, check_install_dependencies
+from utils.config_utils import add_config_section
+from utils.fs_utils import unzip
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+    cmd_sysctl_service,
+    download_file,
+    get_ipv4_addr,
+)
+
+
+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(client.display_name)
+        if not get_confirm(f"Continue {client.display_name} installation?"):
+            return
+
+    # if moonraker is not installed or multiple instances
+    # are installed we enable mainsails remote mode
+    if (
+        client.client == WebClientType.MAINSAIL
+        and not mr_instances
+        or len(mr_instances) > 1
+    ):
+        enable_remotemode = True
+
+    kl_instances = get_instances(Klipper)
+    install_client_cfg = False
+    client_config: BaseWebClientConfig = client.client_config
+    if (
+        kl_instances
+        and not client_config.config_dir.exists()
+        and not detect_client_cfg_conflict(client)
+    ):
+        print_install_client_config_dialog(client)
+        question = f"Download the recommended {client_config.display_name}?"
+        install_client_cfg = get_confirm(question, allow_go_back=False)
+
+    default_port: int = int(settings.get(client.name, "port"))
+    port: int = (
+        default_port if reinstall else get_client_port_selection(client, settings)
+    )
+
+    check_install_dependencies({"nginx"})
+
+    try:
+        download_client(client)
+        if enable_remotemode and client.client == WebClientType.MAINSAIL:
+            enable_mainsail_remotemode()
+
+        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)),
+                ("path", str(client.client_dir)),
+            ],
+        )
+        InstanceManager.restart_all(mr_instances)
+
+        if install_client_cfg and kl_instances:
+            install_client_config(client, False)
+
+        copy_upstream_nginx_cfg()
+        copy_common_vars_nginx_cfg()
+        create_nginx_cfg(
+            display_name=client.display_name,
+            cfg_name=client.name,
+            template_src=MODULE_PATH.joinpath("assets/nginx_cfg"),
+            PORT=port,
+            ROOT_DIR=client.client_dir,
+            NAME=client.name,
+        )
+
+        if kl_instances:
+            symlink_webui_nginx_log(client, kl_instances)
+        cmd_sysctl_service("nginx", "restart")
+
+    except Exception as e:
+        Logger.print_error(e)
+        Logger.print_dialog(
+            DialogType.ERROR,
+            center_content=True,
+            content=[f"{client.display_name} installation failed!"],
+        )
+        return
+
+    # 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:
+    zipfile = f"{client.name.lower()}.zip"
+    target = Path().home().joinpath(zipfile)
+    try:
+        Logger.print_status(
+            f"Downloading {client.display_name} from {client.download_url} ..."
+        )
+        download_file(client.download_url, target, True)
+        Logger.print_ok("Download complete!")
+
+        Logger.print_status(f"Extracting {zipfile} ...")
+        unzip(target, client.client_dir)
+        target.unlink(missing_ok=True)
+        Logger.print_ok("OK!")
+
+    except Exception:
+        Logger.print_error(f"Downloading {client.display_name} failed!")
+        raise
+
+
+def update_client(client: BaseWebClient) -> None:
+    Logger.print_status(f"Updating {client.display_name} ...")
+    if not client.client_dir.exists():
+        Logger.print_info(
+            f"Unable to update {client.display_name}. Directory does not exist! Skipping ..."
+        )
+        return
+
+    with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
+        Logger.print_status(
+            f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
+        )
+        shutil.copy(client.config_file, tmp_file.name)
+        download_client(client)
+        shutil.copy(tmp_file.name, client.config_file)

kiauh/components/webui_client/client_utils.py

@@ -0,0 +1,453 @@
+# ======================================================================= #
+#  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 json
+import re
+import shutil
+from pathlib import Path
+from subprocess import PIPE, CalledProcessError, run
+from typing import List, get_args
+
+from components.klipper.klipper import Klipper
+from components.webui_client import MODULE_PATH
+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 (
+    NGINX_CONFD,
+    NGINX_SITES_AVAILABLE,
+    NGINX_SITES_ENABLED,
+)
+from core.logger import Logger
+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.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
+
+
+def get_client_status(
+    client: BaseWebClient, fetch_remote: bool = False
+) -> ComponentStatus:
+    files = [
+        NGINX_SITES_AVAILABLE.joinpath(client.name),
+        NGINX_CONFD.joinpath("upstreams.conf"),
+        NGINX_CONFD.joinpath("common_vars.conf"),
+    ]
+    comp_status: ComponentStatus = get_install_status(client.client_dir, files=files)
+
+    # if the client dir does not exist, set the status to not
+    # installed even if the other files are present
+    if not client.client_dir.exists():
+        comp_status.status = 0
+
+    comp_status.local = get_local_client_version(client)
+    comp_status.remote = get_remote_client_version(client) if fetch_remote else None
+    return comp_status
+
+
+def get_client_config_status(client: BaseWebClient) -> ComponentStatus:
+    return get_install_status(client.client_config.config_dir)
+
+
+def get_current_client_config() -> str:
+    mainsail, fluidd = MainsailData(), FluiddData()
+    clients: List[BaseWebClient] = [mainsail, fluidd]
+    installed = [c for c in clients if c.client_config.config_dir.exists()]
+
+    if not installed:
+        return Color.apply("-", Color.CYAN)
+    elif len(installed) == 1:
+        cfg = installed[0].client_config
+        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
+    mainsail_includes, fluidd_includes = [], []
+    klipper_instances: List[Klipper] = get_instances(Klipper)
+    for instance in klipper_instances:
+        scp = SimpleConfigParser()
+        scp.read_file(instance.cfg_file)
+        includes_mainsail = scp.has_section(mainsail.client_config.config_section)
+        includes_fluidd = scp.has_section(fluidd.client_config.config_section)
+
+        if includes_mainsail:
+            mainsail_includes.append(instance)
+        if includes_fluidd:
+            fluidd_includes.append(instance)
+
+        # if both are included in the same file, we have a potential conflict
+        if includes_mainsail and includes_fluidd:
+            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 Color.apply("-", Color.CYAN)
+    elif len(fluidd_includes) > len(mainsail_includes):
+        # there are more instances that include fluidd than mainsail
+        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 Color.apply(mainsail.client_config.display_name, Color.CYAN)
+
+
+def enable_mainsail_remotemode() -> None:
+    Logger.print_status("Enable Mainsails remote mode ...")
+    c_json = MainsailData().client_dir.joinpath("config.json")
+    with open(c_json, "r") as f:
+        config_data = json.load(f)
+    
+    if config_data["instancesDB"] == "browser" or config_data["instancesDB"] == "json":
+        Logger.print_info("Remote mode already configured. Skipped ...")
+        return
+
+    Logger.print_status("Setting instance storage location to 'browser' ...")
+    config_data["instancesDB"] = "browser"
+
+    with open(c_json, "w") as f:
+        json.dump(config_data, f, indent=4)
+    Logger.print_ok("Mainsails remote mode enabled!")
+
+
+def symlink_webui_nginx_log(
+    client: BaseWebClient, klipper_instances: List[Klipper]
+) -> None:
+    Logger.print_status("Link NGINX logs into log directory ...")
+    access_log = client.nginx_access_log
+    error_log = client.nginx_error_log
+
+    for instance in klipper_instances:
+        desti_access = instance.base.log_dir.joinpath(access_log.name)
+        if not desti_access.exists():
+            desti_access.symlink_to(access_log)
+
+        desti_error = instance.base.log_dir.joinpath(error_log.name)
+        if not desti_error.exists():
+            desti_error.symlink_to(error_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")
+
+    if not client.client_dir.exists():
+        return None
+    if not relinfo_file.is_file() and not version_file.is_file():
+        return "n/a"
+
+    if relinfo_file.is_file():
+        with open(relinfo_file, "r") as f:
+            return str(json.load(f)["version"])
+    else:
+        with open(version_file, "r") as f:
+            return f.readlines()[0]
+
+
+def get_remote_client_version(client: BaseWebClient) -> str | None:
+    try:
+        if (tag := get_latest_remote_tag(client.repo_path)) != "":
+            return str(tag)
+        return None
+    except Exception:
+        return None
+
+
+def backup_client_data(client: BaseWebClient) -> None:
+    name = client.name
+    src = client.client_dir
+    dest = client.backup_dir
+
+    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)
+
+
+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)
+
+
+def get_existing_clients() -> List[BaseWebClient]:
+    clients = list(get_args(WebClientType))
+    installed_clients: List[BaseWebClient] = []
+    for client in clients:
+        if client.client_dir.exists():
+            installed_clients.append(client)
+
+    return installed_clients
+
+
+def detect_client_cfg_conflict(curr_client: BaseWebClient) -> bool:
+    """
+    Check if any other client configs are present on the system.
+    It is usually not harmful, but chances are they can conflict each other.
+    Multiple client configs are, at least, redundant to have them installed
+    :param curr_client: The client name to check for the conflict
+    :return: True, if other client configs were found, else False
+    """
+
+    mainsail_cfg_status: ComponentStatus = get_client_config_status(MainsailData())
+    fluidd_cfg_status: ComponentStatus = get_client_config_status(FluiddData())
+
+    if curr_client.client == WebClientType.MAINSAIL and fluidd_cfg_status.status == 2:
+        return True
+    if curr_client.client == WebClientType.FLUIDD and mainsail_cfg_status.status == 2:
+        return True
+
+    return False
+
+
+def get_download_url(base_url: str, client: BaseWebClient) -> str:
+    settings = KiauhSettings()
+    use_unstable = settings.get(client.name, "unstable_releases")
+    stable_url = f"{base_url}/latest/download/{client.name}.zip"
+
+    if not use_unstable:
+        return stable_url
+
+    try:
+        unstable_tag = get_latest_unstable_tag(client.repo_path)
+        if unstable_tag == "":
+            raise Exception
+        return f"{base_url}/download/{unstable_tag}/{client.name}.zip"
+    except Exception:
+        return stable_url
+
+
+#################################################
+## NGINX RELATED FUNCTIONS
+#################################################
+
+
+def copy_upstream_nginx_cfg() -> None:
+    """
+    Creates an upstream.conf in /etc/nginx/conf.d
+    :return: None
+    """
+    source = MODULE_PATH.joinpath("assets/upstreams.conf")
+    target = NGINX_CONFD.joinpath("upstreams.conf")
+    try:
+        command = ["sudo", "cp", source, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def copy_common_vars_nginx_cfg() -> None:
+    """
+    Creates a common_vars.conf in /etc/nginx/conf.d
+    :return: None
+    """
+    source = MODULE_PATH.joinpath("assets/common_vars.conf")
+    target = NGINX_CONFD.joinpath("common_vars.conf")
+    try:
+        command = ["sudo", "cp", source, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
+    """
+    Creates an NGINX config from a template file and
+    replaces all placeholders passed as kwargs. A placeholder must be defined
+    in the template file as %{placeholder}%.
+    :param name: name of the config to create
+    :param template_src: the path to the template file
+    :return: None
+    """
+    tmp = Path.home().joinpath(f"{name}.tmp")
+    shutil.copy(template_src, tmp)
+    with open(tmp, "r+") as f:
+        content = f.read()
+
+        for key, value in kwargs.items():
+            content = content.replace(f"%{key}%", str(value))
+
+        f.seek(0)
+        f.write(content)
+        f.truncate()
+
+    target = NGINX_SITES_AVAILABLE.joinpath(name)
+    try:
+        command = ["sudo", "mv", tmp, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create '{target}': {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def create_nginx_cfg(
+    display_name: str,
+    cfg_name: str,
+    template_src: Path,
+    **kwargs,
+) -> None:
+    from utils.sys_utils import set_nginx_permissions
+
+    try:
+        Logger.print_status(f"Creating NGINX config for {display_name} ...")
+
+        source = NGINX_SITES_AVAILABLE.joinpath(cfg_name)
+        target = NGINX_SITES_ENABLED.joinpath(cfg_name)
+        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+        generate_nginx_cfg_from_template(cfg_name, template_src=template_src, **kwargs)
+        create_symlink(source, target, True)
+        set_nginx_permissions()
+
+        Logger.print_ok(f"NGINX config for {display_name} successfully created.")
+    except Exception:
+        Logger.print_error(f"Creating NGINX config for {display_name} failed!")
+        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
+    :return: A sorted list of listen ports
+    """
+    if not NGINX_SITES_ENABLED.exists():
+        return []
+
+    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)
+
+    return sorted(port_list, key=lambda x: int(x))
+
+
+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:
+    valid_ports = set(range(80, 7125))
+    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

@@ -0,0 +1,58 @@
+# ======================================================================= #
+#  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
+from pathlib import Path
+
+from components.webui_client.base_data import (
+    BaseWebClient,
+    BaseWebClientConfig,
+    WebClientConfigType,
+    WebClientType,
+)
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import NGINX_SITES_AVAILABLE
+
+
+@dataclass()
+class FluiddConfigWeb(BaseWebClientConfig):
+    client_config: WebClientConfigType = WebClientConfigType.FLUIDD
+    name: str = client_config.value
+    display_name: str = name.title()
+    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"
+
+
+@dataclass()
+class FluiddData(BaseWebClient):
+    BASE_DL_URL = "https://github.com/fluidd-core/fluidd/releases"
+
+    client: WebClientType = WebClientType.FLUIDD
+    name: str = client.value
+    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
+    download_url: str | None = None
+
+    def __post_init__(self):
+        from components.webui_client.client_utils import get_download_url
+
+        self.client_config = FluiddConfigWeb()
+        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/mainsail_data.py

@@ -0,0 +1,58 @@
+# ======================================================================= #
+#  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
+from pathlib import Path
+
+from components.webui_client.base_data import (
+    BaseWebClient,
+    BaseWebClientConfig,
+    WebClientConfigType,
+    WebClientType,
+)
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import NGINX_SITES_AVAILABLE
+
+
+@dataclass()
+class MainsailConfigWeb(BaseWebClientConfig):
+    client_config: WebClientConfigType = WebClientConfigType.MAINSAIL
+    name: str = client_config.value
+    display_name: str = name.title()
+    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"
+
+
+@dataclass()
+class MainsailData(BaseWebClient):
+    BASE_DL_URL: str = "https://github.com/mainsail-crew/mainsail/releases"
+
+    client: WebClientType = WebClientType.MAINSAIL
+    name: str = WebClientType.MAINSAIL.value
+    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
+    download_url: str | None = None
+
+    def __post_init__(self):
+        from components.webui_client.client_utils import get_download_url
+
+        self.client_config = MainsailConfigWeb()
+        self.download_url = get_download_url(self.BASE_DL_URL, self)

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

@@ -0,0 +1,114 @@
+# ======================================================================= #
+#  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 import client_remove
+from components.webui_client.base_data import BaseWebClient
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.types.color import Color
+
+
+# noinspection PyUnusedLocal
+class ClientRemoveMenu(BaseMenu):
+    def __init__(
+        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.select_state: bool = False
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.remove_menu import RemoveMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "a": Option(method=self.toggle_all),
+            "1": Option(method=self.toggle_rm_client),
+            "2": Option(method=self.toggle_rm_client_config),
+            "3": Option(method=self.toggle_backup_config_json),
+            "c": Option(method=self.run_removal_process),
+        }
+
+    def print_menu(self) -> None:
+        client_name = self.client.display_name
+        client_config = self.client.client_config
+        client_config_name = client_config.display_name
+
+        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"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ Enter a number and hit enter to select / deselect     ║
+            ║ the specific option for removal.                      ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  a) {sel_state:49} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  1) {o1} Remove {client_name:16}                       ║
+            ║  2) {o2} Remove {client_config_name:24}               ║
+            ║  3) {o3} Backup config.json                            ║
+            ╟───────────────────────────────────────────────────────╢
+            ║  C) Continue                                          ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        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
+
+    def toggle_rm_client_config(self, **kwargs) -> None:
+        self.remove_client_cfg = not self.remove_client_cfg
+
+    def toggle_backup_config_json(self, **kwargs) -> None:
+        self.backup_config_json = not self.backup_config_json
+
+    def run_removal_process(self, **kwargs) -> None:
+        if (
+            not self.remove_client
+            and not self.remove_client_cfg
+            and not self.backup_config_json
+        ):
+            print(Color.apply("Nothing selected ...", Color.RED))
+            return
+
+        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.select_state = False

kiauh/core/backup_manager/__init__.py

@@ -0,0 +1,12 @@
+# ======================================================================= #
+#  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 pathlib import Path
+
+BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")

kiauh/core/backup_manager/backup_manager.py

@@ -0,0 +1,108 @@
+# ======================================================================= #
+#  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 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
+    ) -> bool:
+        Logger.print_status(f"Creating backup of {file} ...")
+
+        if not file.exists():
+            Logger.print_info("File does not exist! Skipping ...")
+            return False
+
+        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!")
+                return True
+            except OSError as e:
+                Logger.print_error(f"Unable to backup '{file}':\n{e}")
+                return False
+        else:
+            Logger.print_info(f"File '{file}' not found ...")
+            return False
+
+    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 None
+
+        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,
+                ignore_dangling_symlinks=True,
+            )
+            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

@@ -0,0 +1,30 @@
+# ======================================================================= #
+#  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 os
+import pwd
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+# global dependencies
+GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
+
+# strings
+INVALID_CHOICE = "Invalid choice. Please select a valid value."
+
+# current user
+CURRENT_USER = pwd.getpwuid(os.getuid())[0]
+
+# dirs
+SYSTEMD = Path("/etc/systemd/system")
+PRINTER_DATA_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-data-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

@@ -0,0 +1,24 @@
+# ======================================================================= #
+#  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 warnings
+from typing import Callable
+
+
+def deprecated(info: str = "", replaced_by: Callable | None = None) -> Callable:
+    def decorator(func) -> Callable:
+        def wrapper(*args, **kwargs):
+            msg = f"{info}{replaced_by.__name__ if replaced_by else ''}"
+            warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

kiauh/core/instance_manager/base_instance.py

@@ -0,0 +1,58 @@
+# ======================================================================= #
+#  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 re
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import List
+
+from utils.fs_utils import get_data_dir
+
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
+
+
+@dataclass(repr=True)
+class BaseInstance:
+    instance_type: type
+    suffix: str
+    log_file_name: str | None = None
+    data_dir: Path = field(init=False)
+    base_folders: List[Path] = field(init=False)
+    cfg_dir: Path = field(init=False)
+    log_dir: Path = field(init=False)
+    gcodes_dir: Path = field(init=False)
+    comms_dir: Path = field(init=False)
+    sysd_dir: Path = field(init=False)
+    is_legacy_instance: bool = field(init=False)
+
+    def __post_init__(self):
+        self.data_dir = get_data_dir(self.instance_type, self.suffix)
+        # the following attributes require the data_dir to be set
+        self.cfg_dir = self.data_dir.joinpath("config")
+        self.log_dir = self.data_dir.joinpath("logs")
+        self.gcodes_dir = self.data_dir.joinpath("gcodes")
+        self.comms_dir = self.data_dir.joinpath("comms")
+        self.sysd_dir = self.data_dir.joinpath("systemd")
+        self.is_legacy_instance = self._set_is_legacy_instance()
+        self.base_folders = [
+            self.data_dir,
+            self.cfg_dir,
+            self.log_dir,
+            self.gcodes_dir,
+            self.comms_dir,
+            self.sysd_dir,
+        ]
+
+    def _set_is_legacy_instance(self) -> bool:
+        legacy_pattern = r"^(?!printer)(.+)_data"
+        match = re.search(legacy_pattern, self.data_dir.name)
+
+        return True if (match and self.suffix != "") else False

kiauh/core/instance_manager/instance_manager.py

@@ -0,0 +1,108 @@
+# ======================================================================= #
+#  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 pathlib import Path
+from subprocess import CalledProcessError
+from typing import List
+
+from core.logger import Logger
+from utils.instance_type import InstanceType
+from utils.sys_utils import cmd_sysctl_service
+
+
+class InstanceManager:
+    @staticmethod
+    def enable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(service_name, "enable")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error enabling service {service_name}:")
+            Logger.print_error(f"{e}")
+
+    @staticmethod
+    def disable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(service_name, "disable")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error disabling {service_name}: {e}")
+            raise
+
+    @staticmethod
+    def start(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(service_name, "start")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error starting {service_name}: {e}")
+            raise
+
+    @staticmethod
+    def stop(instance: InstanceType) -> None:
+        name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(name, "stop")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error stopping {name}: {e}")
+            raise
+
+    @staticmethod
+    def restart(instance: InstanceType) -> None:
+        name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(name, "restart")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error restarting {name}: {e}")
+            raise
+
+    @staticmethod
+    def start_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.start(instance)
+
+    @staticmethod
+    def stop_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.stop(instance)
+
+    @staticmethod
+    def restart_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.restart(instance)
+
+    @staticmethod
+    def remove(instance: InstanceType) -> None:
+        from utils.fs_utils import run_remove_routines
+        from utils.sys_utils import remove_system_service
+
+        try:
+            # remove the service file
+            service_file_path: Path = instance.service_file_path
+            if service_file_path is not None:
+                remove_system_service(service_file_path.name)
+
+            # then remove all the log files
+            if (
+                not instance.log_file_name
+                or not instance.base.log_dir
+                or not instance.base.log_dir.exists()
+            ):
+                return
+
+            files = instance.base.log_dir.iterdir()
+            logs = [f for f in files if f.name.startswith(instance.log_file_name)]
+            for log in logs:
+                Logger.print_status(f"Remove '{log}'")
+                run_remove_routines(log)
+
+        except Exception as e:
+            Logger.print_error(f"Error removing service: {e}")
+            raise

kiauh/core/logger.py

@@ -0,0 +1,169 @@
+# ======================================================================= #
+#  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 enum import Enum
+from typing import List
+
+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)
+    CUSTOM = (None, None)
+
+
+LINE_WIDTH = 53
+
+
+BORDER_TOP: str = "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
+BORDER_BOTTOM: str = "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
+BORDER_TITLE: str = "┠───────────────────────────────────────────────────────┨"
+BORDER_LEFT: str = "┃"
+BORDER_RIGHT: str = "┃"
+
+
+class Logger:
+    @staticmethod
+    def print_info(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[INFO] {msg}" if prefix else msg
+        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
+        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
+        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
+        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
+        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(
+        title: DialogType,
+        content: List[str],
+        center_content: bool = False,
+        custom_title: str | None = None,
+        custom_color: Color | None = None,
+        margin_top: int = 0,
+        margin_bottom: int = 0,
+    ) -> None:
+        """
+        Prints a dialog with the given title and content.
+        Those dialogs should be used to display verbose messages to the user which
+        require simple interaction like confirmation or input. Do not use this for
+        navigating through the application.
+
+        :param title: The type of the dialog.
+        :param content: The content of the dialog.
+        :param center_content: Whether to center the content or not.
+        :param custom_title: A custom title for the dialog.
+        :param custom_color: A custom color for the dialog.
+        :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.
+        """
+        color = Logger._get_dialog_color(title, custom_color)
+        dialog_title = Logger._get_dialog_title(title, custom_title)
+
+        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(
+                Logger.format_content(
+                    content,
+                    LINE_WIDTH,
+                    color,
+                    center_content,
+                )
+            )
+
+        print(Color.apply(BORDER_BOTTOM, color))
+
+        if margin_bottom > 0:
+            print("\n" * margin_bottom, end="")
+
+    @staticmethod
+    def _get_dialog_title(
+        title: DialogType, custom_title: str | None = None
+    ) -> str | None:
+        if title == DialogType.CUSTOM and custom_title:
+            return f"[ {custom_title} ]"
+        return f"[ {title.value[0]} ]" if title.value[0] else None
+
+    @staticmethod
+    def _get_dialog_color(
+        title: DialogType, custom_color: Color | None = None
+    ) -> Color:
+        if title == DialogType.CUSTOM and custom_color:
+            return custom_color
+
+        color: Color = title.value[1] if title.value[1] else Color.WHITE
+
+        return color
+
+    @staticmethod
+    def format_content(
+        content: List[str],
+        line_width: int,
+        color: Color = Color.WHITE,
+        center_content: bool = False,
+        border_left: str = "┃",
+        border_right: str = "┃",
+    ) -> str:
+        wrapper = textwrap.TextWrapper(line_width)
+
+        lines = []
+        for i, c in enumerate(content):
+            paragraph = wrapper.wrap(c)
+            lines.extend(paragraph)
+
+            # add a full blank line if we have a double newline
+            # character unless we are at the end of the list
+            if c == "\n\n" and i < len(content) - 1:
+                lines.append(" " * line_width)
+
+        if not center_content:
+            formatted_lines = [
+                Color.apply(f"{border_left} {line:<{line_width}} {border_right}", color)
+                for line in lines
+            ]
+        else:
+            formatted_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

@@ -0,0 +1,37 @@
+# ======================================================================= #
+#  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
+from enum import Enum
+from typing import Any, Callable, Type
+
+
+@dataclass
+class Option:
+    """
+    Represents a menu option.
+    :param method: Method that will be used to call the menu option
+    :param opt_index: Can be used to pass the user input to the menu option
+    :param opt_data: Can be used to pass any additional data to the menu option
+    """
+
+    def __repr__(self):
+        return f"Option(method={self.method.__name__}, opt_index={self.opt_index}, opt_data={self.opt_data})"
+
+    method: Type[Callable]
+    opt_index: str = ""
+    opt_data: Any = None
+
+
+class FooterType(Enum):
+    QUIT = "QUIT"
+    BACK = "BACK"
+    BACK_HELP = "BACK_HELP"
+    BLANK = "BLANK"

kiauh/core/menus/advanced_menu.py

@@ -0,0 +1,106 @@
+# ======================================================================= #
+#  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.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,
+    KlipperSelectMcuConnectionMenu,
+)
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
+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
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.build),
+            "2": Option(method=self.flash),
+            "3": Option(method=self.build_flash),
+            "4": Option(method=self.get_id),
+            "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:
+        menu = textwrap.dedent(
+            """
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Klipper Firmware:         │ Repository Rollback:      ║
+            ║  1) [Build]               │  6) [Klipper]             ║
+            ║  2) [Flash]               │  7) [Moonraker]           ║
+            ║  3) [Build + Flash]       │                           ║
+            ║  4) [Get MCU ID]          │ System:                   ║
+            ║                           │  8) [Change hostname]     ║
+            ║ Extra Dependencies:       │                           ║
+            ║  5) [Input Shaper]        │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def klipper_rollback(self, **kwargs) -> None:
+        rollback_repository(KLIPPER_DIR, Klipper)
+
+    def moonraker_rollback(self, **kwargs) -> None:
+        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()
+
+    def get_id(self, **kwargs) -> None:
+        KlipperSelectMcuConnectionMenu(
+            previous_menu=self.__class__,
+            standalone=True,
+        ).run()
+
+    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

@@ -0,0 +1,107 @@
+# ======================================================================= #
+#  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.klipper.klipper_utils import backup_klipper_dir
+from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
+from components.moonraker.utils.utils import (
+    backup_moonraker_db_dir,
+    backup_moonraker_dir,
+)
+from components.webui_client.client_utils import (
+    backup_client_config_data,
+    backup_client_data,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.types.color import Color
+from utils.common import backup_printer_config_dir
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.backup_klipper),
+            "2": Option(method=self.backup_moonraker),
+            "3": Option(method=self.backup_printer_config),
+            "4": Option(method=self.backup_moonraker_db),
+            "5": Option(method=self.backup_mainsail),
+            "6": Option(method=self.backup_fluidd),
+            "7": Option(method=self.backup_mainsail_config),
+            "8": Option(method=self.backup_fluidd_config),
+            "9": Option(method=self.backup_klipperscreen),
+        }
+
+    def print_menu(self) -> None:
+        line1 = Color.apply(
+            "INFO: Backups are located in '~/kiauh-backups'", Color.YELLOW
+        )
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ {line1:^62} ║
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Klipper & Moonraker API:  │ Client-Config:            ║
+            ║  1) [Klipper]             │  7) [Mainsail-Config]     ║
+            ║  2) [Moonraker]           │  8) [Fluidd-Config]       ║
+            ║  3) [Config Folder]       │                           ║
+            ║  4) [Moonraker Database]  │ Touchscreen GUI:          ║
+            ║                           │  9) [KlipperScreen]       ║
+            ║ Webinterface:             │                           ║
+            ║  5) [Mainsail]            │                           ║
+            ║  6) [Fluidd]              │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def backup_klipper(self, **kwargs) -> None:
+        backup_klipper_dir()
+
+    def backup_moonraker(self, **kwargs) -> None:
+        backup_moonraker_dir()
+
+    def backup_printer_config(self, **kwargs) -> None:
+        backup_printer_config_dir()
+
+    def backup_moonraker_db(self, **kwargs) -> None:
+        backup_moonraker_db_dir()
+
+    def backup_mainsail(self, **kwargs) -> None:
+        backup_client_data(MainsailData())
+
+    def backup_fluidd(self, **kwargs) -> None:
+        backup_client_data(FluiddData())
+
+    def backup_mainsail_config(self, **kwargs) -> None:
+        backup_client_config_data(MainsailData())
+
+    def backup_fluidd_config(self, **kwargs) -> None:
+        backup_client_config_data(FluiddData())
+
+    def backup_klipperscreen(self, **kwargs) -> None:
+        backup_klipperscreen_dir()

kiauh/core/menus/base_menu.py

@@ -0,0 +1,239 @@
+# ======================================================================= #
+#  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 subprocess
+import sys
+import textwrap
+import traceback
+from abc import abstractmethod
+from enum import Enum
+from typing import Dict, Type
+
+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 -x", shell=True)
+
+
+def print_header() -> None:
+    line1 = " [ KIAUH ] "
+    line2 = "Klipper Installation And Update Helper"
+    line3 = ""
+    color = Color.CYAN
+    count = 62 - len(str(color)) - len(str(Color.RST))
+    header = textwrap.dedent(
+        f"""
+        ╔═══════════════════════════════════════════════════════╗
+        ║ {Color.apply(f"{line1:~^{count}}", color)} ║
+        ║ {Color.apply(f"{line2:^{count}}", color)} ║
+        ║ {Color.apply(f"{line3:~^{count}}", color)} ║
+        ╚═══════════════════════════════════════════════════════╝
+        """
+    )[1:]
+    print(header, end="")
+
+
+def print_quit_footer() -> None:
+    text = "Q) Quit"
+    color = Color.RED
+    count = 62 - len(str(color)) - len(str(Color.RST))
+    footer = textwrap.dedent(
+        f"""
+        ║ {color}{text:^{count}}{Color.RST} ║
+        ╚═══════════════════════════════════════════════════════╝
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_back_footer() -> None:
+    text = "B) « Back"
+    color = Color.GREEN
+    count = 62 - len(str(color)) - len(str(Color.RST))
+    footer = textwrap.dedent(
+        f"""
+        ║ {color}{text:^{count}}{Color.RST} ║
+        ╚═══════════════════════════════════════════════════════╝
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_back_help_footer() -> None:
+    text1 = "B) « Back"
+    text2 = "H) Help [?]"
+    color1 = Color.GREEN
+    color2 = Color.YELLOW
+    count = 34 - len(str(color1)) - len(str(Color.RST))
+    footer = textwrap.dedent(
+        f"""
+        ║ {color1}{text1:^{count}}{Color.RST} │ {color2}{text2:^{count}}{Color.RST} ║
+        ╚═══════════════════════════╧═══════════════════════════╝
+        """
+    )[1:]
+    print(footer, end="")
+
+
+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)
+        obj.__post_init__()
+        return obj
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BaseMenu(metaclass=PostInitCaller):
+    options: Dict[str, Option] = {}
+    options_offset: int = 0
+    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.")
+
+    def __post_init__(self) -> None:
+        self.set_previous_menu(self.previous_menu)
+        self.set_options()
+
+        # conditionally add options based on footer type
+        if self.footer_type is FooterType.QUIT:
+            self.options["q"] = Option(method=self.__exit)
+        if self.footer_type is FooterType.BACK:
+            self.options["b"] = Option(method=self.__go_back)
+        if self.footer_type is FooterType.BACK_HELP:
+            self.options["b"] = Option(method=self.__go_back)
+            self.options["h"] = Option(method=self.__go_to_help)
+        # if defined, add the default option to the options dict
+        if self.default_option is not None:
+            self.options[""] = self.default_option
+
+    def __go_back(self, **kwargs) -> None:
+        if self.previous_menu is None:
+            return
+        self.previous_menu().run()
+
+    def __go_to_help(self, **kwargs) -> None:
+        if self.help_menu is None:
+            return
+        self.help_menu(previous_menu=self.__class__).run()
+
+    def __exit(self, **kwargs) -> None:
+        Logger.print_ok("###### Happy printing!", False)
+        sys.exit(0)
+
+    @abstractmethod
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def set_options(self) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def print_menu(self) -> None:
+        raise NotImplementedError
+
+    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:
+            print_back_footer()
+        elif self.footer_type is FooterType.BACK_HELP:
+            print_back_help_footer()
+        elif self.footer_type is FooterType.BLANK:
+            print_blank_footer()
+        else:
+            raise NotImplementedError("FooterType not correctly implemented!")
+
+    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()
+
+    def run(self) -> None:
+        """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
+        try:
+            self.__display_menu()
+            option = get_selection_input(self.input_label_txt, self.options)
+            selected_option: Option = self.options.get(option)
+
+            selected_option.method(
+                opt_index=selected_option.opt_index,
+                opt_data=selected_option.opt_data,
+            )
+
+            self.run()
+
+        except Exception as e:
+            Logger.print_error(
+                f"An unexpected error occured:\n{e}\n{traceback.format_exc()}"
+            )

kiauh/core/menus/install_menu.py

@@ -0,0 +1,109 @@
+# ======================================================================= #
+#  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.crowsnest.crowsnest import install_crowsnest
+from components.klipper.services.klipper_setup_service import KlipperSetupService
+from components.klipperscreen.klipperscreen import install_klipperscreen
+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 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
+# noinspection PyMethodMayBeStatic
+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
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.install_klipper),
+            "2": Option(method=self.install_moonraker),
+            "3": Option(method=self.install_mainsail),
+            "4": Option(method=self.install_fluidd),
+            "5": Option(method=self.install_mainsail_config),
+            "6": Option(method=self.install_fluidd_config),
+            "7": Option(method=self.install_klipperscreen),
+            "8": Option(method=self.install_crowsnest),
+        }
+
+    def print_menu(self) -> None:
+        menu = textwrap.dedent(
+            """
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Firmware & API:           │ Touchscreen GUI:          ║
+            ║  1) [Klipper]             │  7) [KlipperScreen]       ║
+            ║  2) [Moonraker]           │                           ║
+            ║                           │ Webcam Streamer:          ║
+            ║ Webinterface:             │  8) [Crowsnest]           ║
+            ║  3) [Mainsail]            │                           ║
+            ║  4) [Fluidd]              │                           ║
+            ║                           │                           ║
+            ║ Client-Config:            │                           ║
+            ║  5) [Mainsail-Config]     │                           ║
+            ║  6) [Fluidd-Config]       │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def install_klipper(self, **kwargs) -> None:
+        self.klsvc.install()
+
+    def install_moonraker(self, **kwargs) -> None:
+        self.mrsvc.install()
+
+    def install_mainsail(self, **kwargs) -> None:
+        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:
+        install_client_config(MainsailData())
+
+    def install_fluidd(self, **kwargs) -> None:
+        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:
+        install_client_config(FluiddData())
+
+    def install_klipperscreen(self, **kwargs) -> None:
+        install_klipperscreen()
+
+    def install_crowsnest(self, **kwargs) -> None:
+        install_crowsnest()

kiauh/core/menus/main_menu.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                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import sys
+import textwrap
+from typing import Callable, Type
+
+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.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.logger import Logger
+from core.menus import FooterType
+from core.menus.advanced_menu import AdvancedMenu
+from core.menus.backup_menu import BackupMenu
+from core.menus.base_menu import BaseMenu, Option
+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.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
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class MainMenu(BaseMenu):
+    def __init__(self) -> None:
+        super().__init__()
+
+        self.header: bool = True
+        self.title = "Main Menu"
+        self.title_color = Color.CYAN
+        self.footer_type: FooterType = FooterType.QUIT
+
+        self.version = ""
+        self.kl_status, self.kl_owner, self.kl_repo = "", "", ""
+        self.mr_status, self.mr_owner, self.mr_repo = "", "", ""
+        self.ms_status, self.fl_status, self.ks_status = "", "", ""
+        self.cn_status, self.cc_status = "", ""
+        self._init_status()
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        """MainMenu does not have a previous menu"""
+        pass
+
+    def set_options(self) -> None:
+        self.options = {
+            "0": Option(method=self.log_upload_menu),
+            "1": Option(method=self.install_menu),
+            "2": Option(method=self.update_menu),
+            "3": Option(method=self.remove_menu),
+            "4": Option(method=self.advanced_menu),
+            "5": Option(method=self.backup_menu),
+            "e": Option(method=self.extension_menu),
+            "s": Option(method=self.settings_menu),
+        }
+
+    def _init_status(self) -> None:
+        status_vars = ["kl", "mr", "ms", "fl", "ks", "cn"]
+        for var in status_vars:
+            setattr(
+                self,
+                f"{var}_status",
+                Color.apply("Not installed", Color.RED),
+            )
+
+    def _fetch_status(self) -> None:
+        self.version = get_kiauh_version()
+        self._get_component_status("kl", get_klipper_status)
+        self._get_component_status("mr", get_moonraker_status)
+        self._get_component_status("ms", get_client_status, MainsailData())
+        self._get_component_status("fl", get_client_status, FluiddData())
+        self._get_component_status("ks", get_klipperscreen_status)
+        self._get_component_status("cn", get_crowsnest_status)
+        self.cc_status = get_current_client_config()
+
+    def _get_component_status(self, name: str, status_fn: Callable, *args) -> None:
+        status_data: ComponentStatus = status_fn(*args)
+        code: int = status_data.status
+        status: StatusText = StatusMap[code]
+        owner: str = trunc_string(status_data.owner, 23)
+        repo: str = trunc_string(status_data.repo, 23)
+        instance_count: int = status_data.instances
+
+        count_txt: str = ""
+        if instance_count > 0 and code == 2:
+            count_txt = f": {instance_count}"
+
+        setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
+        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
+        if code == 0:
+            color = Color.RED
+        elif code == 1:
+            color = Color.YELLOW
+        elif code == 2:
+            color = Color.GREEN
+
+        return Color.apply(f"{status}{count}", color)
+
+    def print_menu(self) -> None:
+        self._fetch_status()
+
+        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"""
+            ╟──────────────────┬────────────────────────────────────╢
+            ║  0) [Log-Upload] │   Klipper: {self.kl_status:<{pad1}} ║
+            ║                  │     Owner: {self.kl_owner:<{pad1}} ║
+            ║  1) [Install]    │      Repo: {self.kl_repo:<{pad1}} ║
+            ║  2) [Update]     ├────────────────────────────────────╢
+            ║  3) [Remove]     │ Moonraker: {self.mr_status:<{pad1}} ║
+            ║  4) [Advanced]   │     Owner: {self.mr_owner:<{pad1}} ║
+            ║  5) [Backup]     │      Repo: {self.mr_repo:<{pad1}} ║
+            ║                  ├────────────────────────────────────╢
+            ║  S) [Settings]   │        Mainsail: {self.ms_status:<{pad2}} ║
+            ║                  │          Fluidd: {self.fl_status:<{pad2}} ║
+            ║ Community:       │   Client-Config: {self.cc_status:<{pad2}} ║
+            ║  E) [Extensions] │                                    ║
+            ║                  │   KlipperScreen: {self.ks_status:<{pad2}} ║
+            ║                  │       Crowsnest: {self.cn_status:<{pad2}} ║
+            ╟──────────────────┼────────────────────────────────────╢
+            ║ {footer1:^25} │ {footer2:^43} ║
+            ╟──────────────────┴────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def exit(self, **kwargs) -> None:
+        Logger.print_ok("###### Happy printing!", False)
+        sys.exit(0)
+
+    def log_upload_menu(self, **kwargs) -> None:
+        LogUploadMenu().run()
+
+    def install_menu(self, **kwargs) -> None:
+        InstallMenu(previous_menu=self.__class__).run()
+
+    def update_menu(self, **kwargs) -> None:
+        UpdateMenu(previous_menu=self.__class__).run()
+
+    def remove_menu(self, **kwargs) -> None:
+        RemoveMenu(previous_menu=self.__class__).run()
+
+    def advanced_menu(self, **kwargs) -> None:
+        AdvancedMenu(previous_menu=self.__class__).run()
+
+    def backup_menu(self, **kwargs) -> None:
+        BackupMenu(previous_menu=self.__class__).run()
+
+    def settings_menu(self, **kwargs) -> None:
+        SettingsMenu(previous_menu=self.__class__).run()
+
+    def extension_menu(self, **kwargs) -> None:
+        ExtensionsMenu(previous_menu=self.__class__).run()

kiauh/core/menus/remove_menu.py

@@ -0,0 +1,86 @@
+# ======================================================================= #
+#  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.crowsnest.crowsnest import remove_crowsnest
+from components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
+from components.klipperscreen.klipperscreen import remove_klipperscreen
+from components.moonraker.menus.moonraker_remove_menu import (
+    MoonrakerRemoveMenu,
+)
+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.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.types.color import Color
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.remove_klipper),
+            "2": Option(method=self.remove_moonraker),
+            "3": Option(method=self.remove_mainsail),
+            "4": Option(method=self.remove_fluidd),
+            "5": Option(method=self.remove_klipperscreen),
+            "6": Option(method=self.remove_crowsnest),
+        }
+
+    def print_menu(self) -> None:
+        menu = textwrap.dedent(
+            """
+            ╟───────────────────────────────────────────────────────╢
+            ║ INFO: Configurations and/or any backups will be kept! ║
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Firmware & API:           │ Touchscreen GUI:          ║
+            ║  1) [Klipper]             │  5) [KlipperScreen]       ║
+            ║  2) [Moonraker]           │                           ║
+            ║                           │ Webcam Streamer:          ║
+            ║ Klipper Webinterface:     │  6) [Crowsnest]           ║
+            ║  3) [Mainsail]            │                           ║
+            ║  4) [Fluidd]              │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def remove_klipper(self, **kwargs) -> None:
+        KlipperRemoveMenu(previous_menu=self.__class__).run()
+
+    def remove_moonraker(self, **kwargs) -> None:
+        MoonrakerRemoveMenu(previous_menu=self.__class__).run()
+
+    def remove_mainsail(self, **kwargs) -> None:
+        ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
+
+    def remove_fluidd(self, **kwargs) -> None:
+        ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
+
+    def remove_klipperscreen(self, **kwargs) -> None:
+        remove_klipperscreen()
+
+    def remove_crowsnest(self, **kwargs) -> None:
+        remove_crowsnest()

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

@@ -0,0 +1,140 @@
+# ======================================================================= #
+#  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.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.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
+# noinspection PyMethodMayBeStatic
+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.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:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "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:
+        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"""
+            ╟───────────────────────────────────────────────────────╢
+            ║ 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:                                          ║
+            ║ 5) {o3} Backup before update                           ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def _load_settings(self) -> None:
+        self.settings = KiauhSettings()
+        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
+
+        klipper_status: ComponentStatus = get_klipper_status()
+        moonraker_status: ComponentStatus = get_moonraker_status()
+
+        def trim_repo_url(repo: str) -> str:
+            return repo.replace(".git", "").replace("https://", "").replace("git@", "")
+
+        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.WARNING,
+            [f"No {name} repositories configured in kiauh.cfg!"],
+            center_content=True,
+        )
+
+    def switch_klipper_repo(self, **kwargs) -> None:
+        repos = self.settings.klipper.repositories
+        RepoSelectMenu("klipper", repos=repos, previous_menu=self.__class__).run()
+
+    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
+        self.settings.mainsail.unstable_releases = self.mainsail_unstable
+        self.settings.save()
+
+    def toggle_fluidd_release(self, **kwargs) -> None:
+        self.fluidd_unstable = not self.fluidd_unstable
+        self.settings.fluidd.unstable_releases = self.fluidd_unstable
+        self.settings.save()
+
+    def toggle_backup_before_update(self, **kwargs) -> None:
+        self.auto_backups_enabled = not self.auto_backups_enabled
+        self.settings.kiauh.backup_before_update = self.auto_backups_enabled
+        self.settings.save()

kiauh/core/menus/update_menu.py

@@ -0,0 +1,327 @@
+# ======================================================================= #
+#  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 Callable, List, Type
+
+from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
+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.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,
+)
+from components.webui_client.client_setup import update_client
+from components.webui_client.client_utils import (
+    get_client_config_status,
+    get_client_status,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+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 core.types.component_status import ComponentStatus
+from utils.input_utils import get_confirm
+from utils.sys_utils import (
+    get_upgradable_packages,
+    update_system_package_lists,
+    upgrade_system_packages,
+)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+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] = []
+        self.package_count: int = 0
+
+        self.klipper_local = self.klipper_remote = ""
+        self.moonraker_local = self.moonraker_remote = ""
+        self.mainsail_local = self.mainsail_remote = ""
+        self.mainsail_config_local = self.mainsail_config_remote = ""
+        self.fluidd_local = self.fluidd_remote = ""
+        self.fluidd_config_local = self.fluidd_config_remote = ""
+        self.klipperscreen_local = self.klipperscreen_remote = ""
+        self.crowsnest_local = self.crowsnest_remote = ""
+
+        self.mainsail_data = MainsailData()
+        self.fluidd_data = FluiddData()
+        self.status_data = {
+            "klipper": {
+                "display_name": "Klipper",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "moonraker": {
+                "display_name": "Moonraker",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "mainsail": {
+                "display_name": "Mainsail",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "mainsail_config": {
+                "display_name": "Mainsail-Config",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "fluidd": {
+                "display_name": "Fluidd",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "fluidd_config": {
+                "display_name": "Fluidd-Config",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "klipperscreen": {
+                "display_name": "KlipperScreen",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "crowsnest": {
+                "display_name": "Crowsnest",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+        }
+
+        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
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "a": Option(self.update_all),
+            "1": Option(self.update_klipper),
+            "2": Option(self.update_moonraker),
+            "3": Option(self.update_mainsail),
+            "4": Option(self.update_fluidd),
+            "5": Option(self.update_mainsail_config),
+            "6": Option(self.update_fluidd_config),
+            "7": Option(self.update_klipperscreen),
+            "8": Option(self.update_crowsnest),
+            "9": Option(self.upgrade_system_packages),
+        }
+
+    def print_menu(self) -> None:
+        sysupgrades: str = "No upgrades available."
+        padding = 29
+        if self.package_count > 0:
+            sysupgrades = Color.apply(
+                f"{self.package_count} upgrades available!", Color.GREEN
+            )
+            padding = 38
+
+        menu = textwrap.dedent(
+            f"""
+            ╟───────────────────────┬───────────────┬───────────────╢
+            ║  a) Update all        │               │               ║
+            ║                       │ Current:      │ Latest:       ║
+            ║ Klipper & API:        ├───────────────┼───────────────╢
+            ║  1) Klipper           │ {self.klipper_local:<22} │ {self.klipper_remote:<22} ║
+            ║  2) Moonraker         │ {self.moonraker_local:<22} │ {self.moonraker_remote:<22} ║
+            ║                       │               │               ║
+            ║ Webinterface:         ├───────────────┼───────────────╢
+            ║  3) Mainsail          │ {self.mainsail_local:<22} │ {self.mainsail_remote:<22} ║
+            ║  4) Fluidd            │ {self.fluidd_local:<22} │ {self.fluidd_remote:<22} ║
+            ║                       │               │               ║
+            ║ Client-Config:        ├───────────────┼───────────────╢
+            ║  5) Mainsail-Config   │ {self.mainsail_config_local:<22} │ {self.mainsail_config_remote:<22} ║
+            ║  6) Fluidd-Config     │ {self.fluidd_config_local:<22} │ {self.fluidd_config_remote:<22} ║
+            ║                       │               │               ║
+            ║ Other:                ├───────────────┼───────────────╢
+            ║  7) KlipperScreen     │ {self.klipperscreen_local:<22} │ {self.klipperscreen_remote:<22} ║
+            ║  8) Crowsnest         │ {self.crowsnest_local:<22} │ {self.crowsnest_remote:<22} ║
+            ║                       ├───────────────┴───────────────╢
+            ║  9) System            │ {sysupgrades:^{padding}} ║
+            ╟───────────────────────┴───────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def update_all(self, **kwargs) -> None:
+        Logger.print_status("Updating all components ...")
+        self.update_klipper()
+        self.update_moonraker()
+        self.update_mainsail()
+        self.update_mainsail_config()
+        self.update_fluidd()
+        self.update_fluidd_config()
+        self.update_klipperscreen()
+        self.update_crowsnest()
+        self.upgrade_system_packages()
+
+    def update_klipper(self, **kwargs) -> None:
+        klsvc = KlipperSetupService()
+        self._run_update_routine("klipper", klsvc.update)
+
+    def update_moonraker(self, **kwargs) -> None:
+        mrsvc = MoonrakerSetupService()
+        self._run_update_routine("moonraker", mrsvc.update)
+
+    def update_mainsail(self, **kwargs) -> None:
+        self._run_update_routine(
+            "mainsail",
+            update_client,
+            self.mainsail_data,
+        )
+
+    def update_mainsail_config(self, **kwargs) -> None:
+        self._run_update_routine(
+            "mainsail_config",
+            update_client_config,
+            self.mainsail_data,
+        )
+
+    def update_fluidd(self, **kwargs) -> None:
+        self._run_update_routine(
+            "fluidd",
+            update_client,
+            self.fluidd_data,
+        )
+
+    def update_fluidd_config(self, **kwargs) -> None:
+        self._run_update_routine(
+            "fluidd_config",
+            update_client_config,
+            self.fluidd_data,
+        )
+
+    def update_klipperscreen(self, **kwargs) -> None:
+        self._run_update_routine("klipperscreen", update_klipperscreen)
+
+    def update_crowsnest(self, **kwargs) -> None:
+        self._run_update_routine("crowsnest", update_crowsnest)
+
+    def upgrade_system_packages(self, **kwargs) -> None:
+        self._run_system_updates()
+
+    def _fetch_update_status(self) -> None:
+        self._set_status_data("klipper", get_klipper_status)
+        self._set_status_data("moonraker", get_moonraker_status)
+        self._set_status_data("mainsail", get_client_status, self.mainsail_data, True)
+        self._set_status_data(
+            "mainsail_config", get_client_config_status, self.mainsail_data
+        )
+        self._set_status_data("fluidd", get_client_status, self.fluidd_data, True)
+        self._set_status_data(
+            "fluidd_config", get_client_config_status, self.fluidd_data
+        )
+        self._set_status_data("klipperscreen", get_klipperscreen_status)
+        self._set_status_data("crowsnest", get_crowsnest_status)
+
+        update_system_package_lists(silent=True)
+        self.packages = get_upgradable_packages()
+        self.package_count = len(self.packages)
+
+    def _format_local_status(self, local_version, remote_version) -> str:
+        color = Color.RED
+        if not local_version:
+            color = Color.RED
+        elif local_version == remote_version:
+            color = Color.GREEN
+        elif local_version != remote_version:
+            color = Color.YELLOW
+
+        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)
+
+        self.status_data[name]["installed"] = True if comp_status.status == 2 else False
+        self.status_data[name]["local"] = comp_status.local
+        self.status_data[name]["remote"] = comp_status.remote
+
+        self._set_status_string(name)
+
+    def _set_status_string(self, name: str) -> None:
+        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
+        local_txt = self._format_local_status(local_status, remote_status)
+        remote_txt = Color.apply(remote_status or "-", color)
+
+        setattr(self, f"{name}_local", local_txt)
+        setattr(self, f"{name}_remote", remote_txt)
+
+    def _check_is_installed(self, name: str) -> bool:
+        return self.status_data[name]["installed"]
+
+    def _is_update_available(self, name: str) -> bool:
+        return self.status_data[name]["local"] != self.status_data[name]["remote"]
+
+    def _run_update_routine(self, name: str, update_fn: Callable, *args) -> None:
+        display_name = self.status_data[name]["display_name"]
+        is_installed = self._check_is_installed(name)
+        is_update_available = self._is_update_available(name)
+
+        if not is_installed:
+            Logger.print_info(f"{display_name} is not installed! Skipped ...")
+            return
+        elif not is_update_available:
+            Logger.print_info(f"{display_name} is already up to date! Skipped ...")
+            return
+
+        update_fn(*args)
+
+    def _run_system_updates(self) -> None:
+        if not self.packages:
+            Logger.print_info("No system upgrades available!")
+            return
+
+        try:
+            pkgs: str = ", ".join(self.packages)
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                ["The following packages will be upgraded:", "\n\n", pkgs],
+                custom_title="UPGRADABLE SYSTEM UPDATES",
+            )
+            if not get_confirm("Continue?"):
+                return
+            Logger.print_status("Upgrading system packages ...")
+            upgrade_system_packages(self.packages)
+        except Exception as e:
+            Logger.print_error(f"Error upgrading system packages:\n{e}")
+            raise

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

@@ -0,0 +1,414 @@
+# ======================================================================= #
+#  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 dataclasses import dataclass, field
+from typing import Any, Callable, List, TypeVar
+
+from components.klipper import KLIPPER_REPO_URL
+from components.moonraker import MOONRAKER_REPO_URL
+from core.backup_manager.backup_manager import BackupManager
+from core.logger import DialogType, Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+from utils.input_utils import get_confirm
+from utils.sys_utils import kill
+
+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:
+    backup_before_update: bool | None = field(default=None)
+
+
+@dataclass
+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: int | None = field(default=None)
+    unstable_releases: bool | None = field(default=None)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KiauhSettings:
+    __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
+
+    def __repr__(self) -> str:
+        return (
+            f"KiauhSettings(kiauh={self.kiauh}, klipper={self.klipper},"
+            f" moonraker={self.moonraker}, mainsail={self.mainsail},"
+            f" fluidd={self.fluidd})"
+        )
+
+    def __getitem__(self, item: str) -> Any:
+        return getattr(self, item)
+
+    def __init__(self) -> None:
+        if self.__initialized:
+            return
+        self.__initialized = True
+
+        self.config = SimpleConfigParser()
+        self.kiauh = AppSettings()
+        self.klipper = KlipperSettings()
+        self.moonraker = MoonrakerSettings()
+        self.mainsail = WebUiSettings()
+        self.fluidd = WebUiSettings()
+
+        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
+        strings. Prefer direct access to the properties, as it is usually safer!
+        :param section: The section name as string.
+        :param option: The option name as string.
+        :return: The value of the option as string, int or bool.
+        """
+
+        try:
+            section = getattr(self, section)
+            value = getattr(section, option)
+            return value  # type: ignore
+        except AttributeError:
+            raise
+
+    def save(self) -> None:
+        self.__write_internal_state_to_cfg()
+        self.__read_config_set_internal_state()
+
+    def __read_config_set_internal_state(self) -> None:
+        if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
+            Logger.print_dialog(
+                DialogType.ERROR,
+                [
+                    "No KIAUH configuration file found! Please make sure you have at least "
+                    "one of the following configuration files in KIAUH's root directory:",
+                    "● default.kiauh.cfg",
+                    "● kiauh.cfg",
+                ],
+            )
+            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,
+        silent: bool = False,
+    ) -> T:
+        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 repo in repos:
+            try:
+                if repo.strip().startswith("#") or repo.strip().startswith(";"):
+                    continue
+                if "," in repo:
+                    url, branch = repo.strip().split(",")
+
+                    if not branch:
+                        branch = "master"
+                else:
+                    url = repo.strip()
+                    branch = "master"
+
+                # url must not be empty otherwise it's considered
+                # as an unrecoverable, invalid configuration
+                if not url:
+                    raise InvalidValueError(section, "repositories", repo)
+
+                _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:
+        bm = BackupManager()
+        if not bm.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

@@ -0,0 +1,42 @@
+import sys
+import threading
+import time
+from typing import List, Literal
+
+from core.types.color import Color
+
+SpinnerColor = Literal["white", "red", "green", "yellow"]
+
+
+class Spinner:
+    def __init__(
+        self,
+        message: str = "Loading",
+        interval: float = 0.2,
+    ) -> None:
+        self.message = f"{message} ..."
+        self.interval = interval
+        self._stop_event = threading.Event()
+        self._thread = threading.Thread(target=self._animate)
+
+    def _animate(self) -> None:
+        animation: List[str] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
+        while not self._stop_event.is_set():
+            for char in animation:
+                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():
+                    break
+        sys.stdout.write("\r" + " " * (len(self.message) + 1) + "\r")
+        sys.stdout.flush()
+
+    def start(self) -> None:
+        self._stop_event.clear()
+        if not self._thread.is_alive():
+            self._thread = threading.Thread(target=self._animate)
+            self._thread.start()
+
+    def stop(self) -> None:
+        self._stop_event.set()
+        self._thread.join()