feat: first implementation of firmware flashing via usb and regular flash command

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

.github/FUNDING.yml

@@ -9,4 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
 liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+custom: https://paypal.me/dwillner0

.gitignore

@@ -1,3 +1,4 @@
+.idea
 .vscode
 .idea
 .pytest_cache

README.md

@@ -29,7 +29,7 @@
 ### 📋 Prerequisites
 KIAUH is a script that assists you in installing Klipper on a Linux operating system that has
 already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure 
-that you have a functional Linux system on hand. `Raspberry Pi OS Lite (32bit)` is a recommended Linux image 
+that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image 
 if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/) 
 is the simplest way to flash an image like this to an SD card.
 
@@ -39,7 +39,7 @@ select `Choose OS -> Raspberry Pi OS (other)`: \
   <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
 </p>
 
-* Then select `Raspberry Pi OS Lite (32bit)`:
+* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that instead):
 <p align="center">
   <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
 </p>
@@ -125,7 +125,7 @@ prompt and confirm by hitting ENTER.
 <tr>
 <th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
 <th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
-<th><img src="https://camo.githubusercontent.com/627be7fc67195b626b298af9b9677d7c58e698c67305e54324cffbe06130d4a4/68747470733a2f2f6f63746f7072696e742e6f72672f6173736574732f696d672f6c6f676f2e706e67" alt="OctoPrint Logo" height="64"></th>
+<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
 </tr>
 <tr>
 <th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>

kiauh.sh

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

kiauh/components/klipper_firmware/flash_options.py

@@ -0,0 +1,48 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from dataclasses import field, dataclass
+from enum import Enum
+from typing import Union, 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"
+    UART = "UART"
+
+
+@dataclass
+class FlashOptions:
+    _instance = None
+    flash_method: Union[FlashMethod, None] = None
+    flash_command: Union[FlashCommand, None] = None
+    connection_type: Union[ConnectionType, None] = None
+    mcu_list: List[str] = field(default_factory=list)
+    selected_mcu: str = ""
+    selected_board: str = ""
+
+    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):
+        cls._instance = None

kiauh/components/klipper_firmware/flash_utils.py

@@ -0,0 +1,77 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from subprocess import CalledProcessError, check_output, Popen, PIPE, STDOUT
+from typing import List
+
+from components.klipper import KLIPPER_DIR
+from components.klipper_firmware.flash_options import FlashOptions, FlashCommand
+from utils.logger import Logger
+from utils.system_utils import log_process
+
+
+def find_usb_device_by_id() -> List[str]:
+    try:
+        command = "find /dev/serial/by-id/* 2>/dev/null"
+        output = check_output(command, shell=True, text=True)
+        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:
+        command = '"find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null"'
+        output = check_output(command, shell=True, text=True)
+        return output.splitlines()
+    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:
+        command = '"lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null"'
+        output = check_output(command, shell=True, text=True)
+        return output.splitlines()
+    except CalledProcessError as e:
+        Logger.print_error("Unable to find a USB DFU device!")
+        Logger.print_error(e, prefix=False)
+        return []
+
+
+def flash_device(flash_options: FlashOptions) -> None:
+    try:
+        if not flash_options.selected_mcu:
+            raise Exception("Missing value for selected_mcu!")
+
+        if flash_options.flash_command is FlashCommand.FLASH:
+            command = [
+                "make",
+                flash_options.flash_command.value,
+                f"FLASH_DEVICE={flash_options.selected_mcu}",
+            ]
+            process = Popen(
+                command, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True
+            )
+
+            log_process(process)
+
+            rc = process.returncode
+            if rc != 0:
+                raise Exception(f"Flashing failed with returncode: {rc}")
+            else:
+                Logger.print_ok("Flashing successfull!", 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")

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -0,0 +1,381 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from components.klipper_firmware.flash_options import (
+    FlashOptions,
+    FlashMethod,
+    FlashCommand,
+    ConnectionType,
+)
+from components.klipper_firmware.flash_utils import (
+    find_usb_device_by_id,
+    find_uart_device,
+    find_usb_dfu_device,
+    flash_device,
+)
+from core.menus import BACK_HELP_FOOTER, BACK_FOOTER
+
+from core.menus.base_menu import BaseMenu
+from utils.constants import COLOR_CYAN, RESET_FORMAT, COLOR_YELLOW, COLOR_RED
+from utils.input_utils import get_confirm
+from utils.logger import Logger
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashMethodMenu(BaseMenu):
+    def __init__(self):
+        self.flash_options = FlashOptions()
+        super().__init__(
+            header=False,
+            options={
+                "1": self.select_regular,
+                "2": self.select_sdcard,
+                "h": KlipperFlashMethodHelpMenu,
+            },
+            input_label_txt="Select flash method",
+            footer_type=BACK_HELP_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        header = " [ Flash MCU ] "
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Please select the flashing method to flash your MCU.  |
+            | Make sure to only select a method your MCU supports.  |
+            | Not all MCUs support both methods!                    |
+            |-------------------------------------------------------|
+            |                                                       |
+            | 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):
+        next_menu = KlipperFlashCommandMenu(previous_menu=self)
+        next_menu.start()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashCommandMenu(BaseMenu):
+    def __init__(self, previous_menu: BaseMenu):
+        self.flash_options = FlashOptions()
+        super().__init__(
+            header=False,
+            options={
+                "1": self.select_flash,
+                "2": self.select_serialflash,
+                "h": KlipperFlashCommandHelpMenu,
+            },
+            default_option="1",
+            input_label_txt="Select flash command",
+            previous_menu=previous_menu,
+            footer_type=BACK_HELP_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        menu = textwrap.dedent(
+            """
+            /=======================================================\\
+            |                                                       |
+            | Which flash command to use for flashing the MCU?      |
+            | 1) make flash (default)                               |
+            | 2) make serialflash (stm32flash)                      |
+            |                                                       |
+            """
+        )[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):
+        next_menu = KlipperSelectMcuConnectionMenu(previous_menu=self)
+        next_menu.start()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuConnectionMenu(BaseMenu):
+    def __init__(self, previous_menu: BaseMenu):
+        self.flash_options = FlashOptions()
+        super().__init__(
+            header=False,
+            options={
+                "1": self.select_usb,
+                "2": self.select_dfu,
+                "3": self.select_usb_dfu,
+                "h": KlipperMcuConnectionHelpMenu,
+            },
+            input_label_txt="Select connection type",
+            previous_menu=previous_menu,
+            footer_type=BACK_HELP_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        header = "Make sure that the controller board is connected now!"
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            |                                                       |
+            | How is the controller board connected to the host?    |
+            | 1) USB                                                |
+            | 2) UART                                               |
+            | 3) USB (DFU mode)                                     |
+            |                                                       |
+            """
+        )[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 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()
+
+        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.")
+        else:
+            self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        next_menu = KlipperSelectMcuIdMenu(previous_menu=self)
+        next_menu.start()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuIdMenu(BaseMenu):
+    def __init__(self, previous_menu: BaseMenu):
+        self.flash_options = FlashOptions()
+        self.mcu_list = self.flash_options.mcu_list
+        options = {f"{index}": self.flash_mcu for index in range(len(self.mcu_list))}
+        super().__init__(
+            header=False,
+            options=options,
+            input_label_txt="Select MCU to flash",
+            previous_menu=previous_menu,
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        header = "!!! ATTENTION !!!"
+        header2 = f"[{COLOR_CYAN}List of available MCUs{RESET_FORMAT}]"
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Make sure, to select the correct MCU!                 |
+            | ONLY flash a firmware created for the respective MCU! |
+            |                                                       |
+            |{header2:-^64}|
+            
+            """
+        )[1:]
+
+        for i, mcu in enumerate(self.mcu_list):
+            mcu = mcu.split("/")[-1]
+            menu += f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
+
+        print(menu, end="\n")
+
+    def flash_mcu(self, **kwargs):
+        index = int(kwargs.get("opt_index"))
+        selected_mcu = self.mcu_list[index]
+        self.flash_options.selected_mcu = selected_mcu
+
+        print(f"{COLOR_CYAN}###### You selected:{RESET_FORMAT}")
+        print(f"● MCU #{index}: {selected_mcu}\n")
+
+        if get_confirm("Continue", allow_go_back=True):
+            Logger.print_status(f"Flashing '{selected_mcu}' ...")
+            flash_device(self.flash_options)
+
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        pass
+        # TODO: navigate back to advanced menu after flashing
+
+        # from core.menus.main_menu import MainMenu
+        # from core.menus.advanced_menu import AdvancedMenu
+        #
+        # next_menu = AdvancedMenu()
+        # next_menu.start()
+
+
+class KlipperFlashMethodHelpMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=False,
+            options={},
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        header = " < ? > Help: Flash MCU < ? > "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
+        subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | {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="")
+
+
+class KlipperFlashCommandHelpMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=False,
+            options={},
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        header = " < ? > Help: Flash MCU < ? > "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
+        subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | {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="")
+
+
+class KlipperMcuConnectionHelpMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=False,
+            options={},
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self) -> None:
+        header = " < ? > Help: Flash MCU < ? > "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
+        subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | {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.                               |
+            |                                                       |
+            """
+        )[1:]
+        print(menu, end="")

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -41,8 +41,7 @@ class LogUploadMenu(BaseMenu):
             """
         )[1:]
 
-        logfile_list = get_logfile_list()
-        for logfile in enumerate(logfile_list):
+        for logfile in enumerate(self.logfile_list):
             line = f"{logfile[0]}) {logfile[1].get('display_name')}"
             menu += f"| {line:<54}|\n"
 

kiauh/core/menus/advanced_menu.py

@@ -9,7 +9,7 @@
 
 import textwrap
 
-from components.klipper_firmware.menus.klipper_flash_menu import KlipperFlashMenu
+from components.klipper_firmware.menus.klipper_flash_menu import KlipperFlashMethodMenu
 from core.menus import BACK_FOOTER
 from core.menus.base_menu import BaseMenu
 from utils.constants import COLOR_YELLOW, RESET_FORMAT
@@ -23,7 +23,7 @@ class AdvancedMenu(BaseMenu):
                 "1": None,
                 "2": None,
                 "3": None,
-                "4": KlipperFlashMenu,
+                "4": KlipperFlashMethodMenu,
                 "5": None,
                 "6": None,
             },

kiauh/core/menus/base_menu.py

@@ -7,6 +7,8 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
+from __future__ import annotations
+
 import subprocess
 import sys
 import textwrap
@@ -97,14 +99,19 @@ class BaseMenu(ABC):
         self,
         options: Dict[str, Union[Callable, Any]],
         options_offset: int = 0,
+        default_option: Union[str, None] = None,
+        input_label_txt: Union[str, None] = None,
         header: bool = True,
+        previous_menu: BaseMenu = None,
         footer_type: Literal[
             "QUIT_FOOTER", "BACK_FOOTER", "BACK_HELP_FOOTER"
         ] = QUIT_FOOTER,
     ):
-        self.previous_menu = None
+        self.previous_menu = previous_menu
         self.options = options
+        self.default_option = default_option
         self.options_offset = options_offset
+        self.input_label_txt = input_label_txt
         self.header = header
         self.footer_type = footer_type
 
@@ -130,7 +137,12 @@ class BaseMenu(ABC):
 
     def handle_user_input(self) -> str:
         while True:
-            choice = input(f"{COLOR_CYAN}###### Perform action: {RESET_FORMAT}").lower()
+            label_text = (
+                "Perform action"
+                if self.input_label_txt is None or self.input_label_txt == ""
+                else self.input_label_txt
+            )
+            choice = input(f"{COLOR_CYAN}###### {label_text}: {RESET_FORMAT}").lower()
             option = self.options.get(choice, None)
 
             has_navi_option = self.footer_type in self.NAVI_OPTIONS
@@ -140,6 +152,8 @@ class BaseMenu(ABC):
 
             if option is not None:
                 return choice
+            elif option is None and self.default_option is not None:
+                return self.default_option
             else:
                 Logger.print_error("Invalid input!", False)
 

kiauh/utils/system_utils.py

@@ -10,7 +10,7 @@
 import os
 import shutil
 import socket
-import subprocess
+from subprocess import Popen, PIPE, CalledProcessError, run, DEVNULL
 import sys
 import time
 import urllib.error
@@ -19,6 +19,8 @@ import venv
 from pathlib import Path
 from typing import List, Literal
 
+import select
+
 from utils.input_utils import get_confirm
 from utils.logger import Logger
 from utils.filesystem_utils import check_file_exist
@@ -73,7 +75,7 @@ def create_python_venv(target: Path) -> None:
         except OSError as e:
             Logger.print_error(f"Error setting up virtualenv:\n{e}")
             raise
-        except subprocess.CalledProcessError as e:
+        except CalledProcessError as e:
             Logger.print_error(f"Error setting up virtualenv:\n{e.output.decode()}")
             raise
     else:
@@ -103,7 +105,7 @@ def update_python_pip(target: Path) -> None:
             raise FileNotFoundError("Error updating pip! Not found.")
 
         command = [pip_location, "install", "-U", "pip"]
-        result = subprocess.run(command, stderr=subprocess.PIPE, text=True)
+        result = run(command, stderr=PIPE, text=True)
         if result.returncode != 0 or result.stderr:
             Logger.print_error(f"{result.stderr}", False)
             Logger.print_error("Updating pip failed!")
@@ -113,7 +115,7 @@ def update_python_pip(target: Path) -> None:
     except FileNotFoundError as e:
         Logger.print_error(e)
         raise
-    except subprocess.CalledProcessError as e:
+    except CalledProcessError as e:
         Logger.print_error(f"Error updating pip:\n{e.output.decode()}")
         raise
 
@@ -136,7 +138,7 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
             "-r",
             f"{requirements}",
         ]
-        result = subprocess.run(command, stderr=subprocess.PIPE, text=True)
+        result = run(command, stderr=PIPE, text=True)
 
         if result.returncode != 0 or result.stderr:
             Logger.print_error(f"{result.stderr}", False)
@@ -144,7 +146,7 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
             return
 
         Logger.print_ok("Installing Python requirements successful!")
-    except subprocess.CalledProcessError as e:
+    except CalledProcessError as e:
         log = f"Error installing Python requirements:\n{e.output.decode()}"
         Logger.print_error(log)
         raise
@@ -180,14 +182,14 @@ def update_system_package_lists(silent: bool, rls_info_change=False) -> None:
         if rls_info_change:
             command.append("--allow-releaseinfo-change")
 
-        result = subprocess.run(command, stderr=subprocess.PIPE, text=True)
+        result = run(command, stderr=PIPE, text=True)
         if result.returncode != 0 or result.stderr:
             Logger.print_error(f"{result.stderr}", False)
             Logger.print_error("Updating system package list failed!")
             return
 
         Logger.print_ok("System package list update successful!")
-    except subprocess.CalledProcessError as e:
+    except CalledProcessError as e:
         kill(f"Error updating system package list:\n{e.stderr.decode()}")
 
 
@@ -200,10 +202,10 @@ def check_package_install(packages: List[str]) -> List[str]:
     not_installed = []
     for package in packages:
         command = ["dpkg-query", "-f'${Status}'", "--show", package]
-        result = subprocess.run(
+        result = run(
             command,
-            stdout=subprocess.PIPE,
-            stderr=subprocess.DEVNULL,
+            stdout=PIPE,
+            stderr=DEVNULL,
             text=True,
         )
         if "installed" not in result.stdout.strip("'").split():
@@ -224,10 +226,10 @@ def install_system_packages(packages: List[str]) -> None:
         command = ["sudo", "apt-get", "install", "-y"]
         for pkg in packages:
             command.append(pkg)
-        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+        run(command, stderr=PIPE, check=True)
 
         Logger.print_ok("Packages installed successfully.")
-    except subprocess.CalledProcessError as e:
+    except CalledProcessError as e:
         kill(f"Error installing packages:\n{e.stderr.decode()}")
 
 
@@ -239,8 +241,8 @@ def mask_system_service(service_name: str) -> None:
     """
     try:
         command = ["sudo", "systemctl", "mask", service_name]
-        subprocess.run(command, stderr=subprocess.PIPE, check=True)
-    except subprocess.CalledProcessError as e:
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
         log = f"Unable to mask system service {service_name}: {e.stderr.decode()}"
         Logger.print_error(log)
         raise
@@ -318,12 +320,12 @@ def set_nginx_permissions() -> None:
     :return: None
     """
     cmd = f"ls -ld {Path.home()} | cut -d' ' -f1"
-    homedir_perm = subprocess.run(cmd, shell=True, stdout=subprocess.PIPE, text=True)
+    homedir_perm = run(cmd, shell=True, stdout=PIPE, text=True)
     homedir_perm = homedir_perm.stdout
 
     if homedir_perm.count("x") < 3:
         Logger.print_status("Granting NGINX the required permissions ...")
-        subprocess.run(["chmod", "og+x", Path.home()])
+        run(["chmod", "og+x", Path.home()])
         Logger.print_ok("Permissions granted.")
 
 
@@ -339,9 +341,30 @@ def control_systemd_service(
     try:
         Logger.print_status(f"{action.capitalize()} {name}.service ...")
         command = ["sudo", "systemctl", action, f"{name}.service"]
-        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+        run(command, stderr=PIPE, check=True)
         Logger.print_ok("OK!")
-    except subprocess.CalledProcessError as e:
+    except CalledProcessError as e:
         log = f"Failed to {action} {name}.service: {e.stderr.decode()}"
         Logger.print_error(log)
         raise
+
+
+def log_process(process: Popen) -> None:
+    """
+    Helper method to print stdout of a process in near realtime to the console.
+    :param process: Process to log the output from
+    :return: None
+    """
+    while True:
+        reads = [process.stdout.fileno()]
+        ret = select.select(reads, [], [])
+        for fd in ret[0]:
+            if fd == process.stdout.fileno():
+                line = process.stdout.readline()
+                if line:
+                    print(line.strip(), flush=True)
+                else:
+                    break
+
+        if process.poll() is not None:
+            break

resources/example.printer.cfg

@@ -1,7 +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
+max_accel: 1000

scripts/backup.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -33,23 +33,27 @@ function backup_before_update() {
 
 function backup_config_dir() {
   check_for_backup_dir
-  local current_date instance_names config_pathes
+  local current_date config_pathes
 
   config_pathes=$(get_config_folders)
-  readarray -t -d" " instance_names < <(get_multi_instance_names)
 
   if [[ -n "${config_pathes}" ]]; then
     current_date=$(get_date)
     status_msg "Timestamp: ${current_date}"
 
-    local i=0 folder
+    local i=0 folder folder_name target_dir
     for folder in ${config_pathes}; do
-      local folder_name="${instance_names[${i}]}"
-      status_msg "Create backup of ${folder} ..."
-      mkdir -p "${BACKUP_DIR}/configs/${current_date}/${folder_name}"
-      cp -r "${folder}" "${_}"
-      ok_msg "Backup created in:\n${BACKUP_DIR}/configs/${current_date}/${folder_name}"
-      i=$(( i + 1 ))
+      if [[ -d ${folder} ]]; then
+        status_msg "Create backup of ${folder} ..."
+  
+        folder_name=$(echo "${folder}" | rev | cut -d"/" -f2 | rev)
+        target_dir="${BACKUP_DIR}/configs/${current_date}/${folder_name}"
+        mkdir -p "${target_dir}"
+        cp -r "${folder}" "${target_dir}"
+        i=$(( i + 1 ))
+  
+        ok_msg "Backup created in:\n${target_dir}"
+      fi
     done
   else
     ok_msg "No config directory found! Skipping backup ..."
@@ -61,20 +65,22 @@ function backup_moonraker_database() {
   local current_date db_pathes
 
   db_pathes=$(get_instance_folder_path "database")
-  readarray -t -d" " instance_names < <(get_multi_instance_names)
 
   if [[ -n ${db_pathes} ]]; then
     current_date=$(get_date)
     status_msg "Timestamp: ${current_date}"
 
-    local i=0 database
+    local i=0 database folder_name target_dir
     for database in ${db_pathes}; do
-      local folder_name="${instance_names[${i}]}"
       status_msg "Create backup of ${database} ..."
-      mkdir -p "${BACKUP_DIR}/moonraker_databases/${current_date}/${folder_name}"
-      cp -r "${database}" "${_}"
-      ok_msg "Backup created in:\n${BACKUP_DIR}/moonraker_databases/${current_date}/${folder_name}"
+
+      folder_name=$(echo "${database}" | rev | cut -d"/" -f2 | rev)
+      target_dir="${BACKUP_DIR}/moonraker_databases/${current_date}/${folder_name}"
+      mkdir -p "${target_dir}"
+      cp -r "${database}" "${target_dir}"
       i=$(( i + 1 ))
+
+      ok_msg "Backup created in:\n${target_dir}"
     done
   else
     print_error "No Moonraker database found! Skipping backup ..."
@@ -191,3 +197,19 @@ function backup_telegram_bot() {
     print_error "Can't back up MoonrakerTelegramBot directory!\n Not found!"
   fi
 }
+
+function backup_octoeverywhere() {
+  local current_date
+
+  if [[ -d ${OCTOEVERYWHERE_DIR} ]] ; then
+    status_msg "Creating OctoEverywhere backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/OctoEverywhere-backups/${current_date}"
+    cp -r "${OCTOEVERYWHERE_DIR}" "${_}" && cp -r "${OCTOEVERYWHERE_ENV}" "${_}"
+    print_confirm "OctoEverywhere backup complete!"
+  else
+    print_error "Can't back up OctoEverywhere directory!\n Not found!"
+  fi
+}

scripts/crowsnest.sh

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

scripts/flash_klipper.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -52,16 +52,57 @@ function init_flash_process() {
     esac
   done
 
-  ### step 2: select how the mcu is connected to the host
+  ### step 2: select how the mcu is flashed (flash/serialflash)
+  select_flash_command
+
+  ### step 3: select how the mcu is connected to the host
   select_mcu_connection
 
-  ### step 3: select which detected mcu should be flashed
+  ### step 4: select which detected mcu should be flashed
   select_mcu_id "${method}"
 }
 
 #================================================#
 #=================== STEP 2 =====================#
 #================================================#
+function select_flash_command() {
+  unset flash_command
+
+  top_border
+  echo -e "| How to flash MCU?                                     |"
+  echo -e "| 1) make flash (default)                               |"
+  echo -e "| 2) make serialflash (stm32flash)                      |"
+  blank_line
+  back_help_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Flashing command:${white} " -i "1" -e choice
+    case "${choice}" in
+      1)
+        select_msg "Selected 'make flash' command"
+        flash_command="flash"
+        break;;
+      2)
+        select_msg "Selected 'make serialflash' command"
+        flash_command="serialflash"
+        break;;
+      B|b)
+        advanced_menu
+        break;;
+      H|h)
+        clear && print_header
+        show_mcu_flash_command_help
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+#================================================#
+#=================== STEP 3 =====================#
+#================================================#
 function select_mcu_connection() {
   top_border
   echo -e "| ${yellow}Make sure that the controller board is connected now!${white} |"
@@ -112,7 +153,6 @@ function print_detected_mcu_to_screen() {
   fi
 
   for mcu in "${mcu_list[@]}"; do
-    mcu=$(echo "${mcu}" | rev | cut -d"/" -f1 | rev)
     echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
     i=$(( i + 1 ))
   done
@@ -120,7 +160,7 @@ function print_detected_mcu_to_screen() {
 }
 
 #================================================#
-#=================== STEP 3 =====================#
+#=================== STEP 4 =====================#
 #================================================#
 function select_mcu_id() {
   local i=0 sel_index=0 method=${1}
@@ -195,7 +235,7 @@ function start_flash_mcu() {
   local device=${1}
   do_action_service "stop" "klipper"
 
-  if make flash FLASH_DEVICE="${device}"; then
+  if make ${flash_command} FLASH_DEVICE="${device}"; then
     ok_msg "Flashing successfull!"
   else
     warn_msg "Flashing failed!"
@@ -387,6 +427,36 @@ function show_flash_method_help() {
   done
 }
 
+function show_mcu_flash_command_help() {
+  top_border
+  echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
+  hr
+  echo -e "| ${cyan}make flash:${white}                                           |"
+  echo -e "| The default command to flash controller board, it     |"
+  echo -e "| will detect selected microcontroller and use suitable |"
+  echo -e "| tool for flashing it.                                 |"
+  blank_line
+  echo -e "| ${cyan}make serialflash:${white}                                     |"
+  echo -e "| Special command to flash STM32 microcontrollers in    |"
+  echo -e "| DFU mode but connected via serial. stm32flash command |"
+  echo -e "| will be used internally.                              |"
+  blank_line
+  back_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Please select:${white} " choice
+    case "${choice}" in
+      B|b)
+        clear && print_header
+        select_flash_command
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
 function show_mcu_connection_help() {
   top_border
   echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"

scripts/fluidd.sh

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

scripts/gcode_shell_command.sh

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

scripts/globals.sh

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

scripts/klipper.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -244,6 +244,7 @@ function run_klipper_setup() {
 
   ### finalizing the setup with writing instance names to the kiauh.ini
   set_multi_instance_names
+  mask_disrupting_services
 
   print_confirm "${confirm}" && return
 }
@@ -333,6 +334,7 @@ function create_klipper_service() {
 
   local printer_data
   local cfg_dir
+  local gcodes_dir
   local cfg
   local log
   local klippy_serial
@@ -345,6 +347,7 @@ function create_klipper_service() {
 
   printer_data="${HOME}/${instance_name}_data"
   cfg_dir="${printer_data}/config"
+  gcodes_dir="${printer_data}/gcodes"
   cfg="${cfg_dir}/printer.cfg"
   log="${printer_data}/logs/klippy.log"
   klippy_serial="${printer_data}/comms/klippy.serial"
@@ -375,18 +378,20 @@ function create_klipper_service() {
   fi
 
   if [[ ! -f ${cfg} ]]; then
-    write_example_printer_cfg "${cfg}"
+    write_example_printer_cfg "${cfg}" "${gcodes_dir}"
   fi
 }
 
 function write_example_printer_cfg() {
   local cfg=${1}
+  local gcodes_dir=${2}
   local cfg_template
 
   cfg_template="${KIAUH_SRCDIR}/resources/example.printer.cfg"
 
   status_msg "Creating minimal example printer.cfg ..."
   if cp "${cfg_template}" "${cfg}"; then
+    sed -i "s|%GCODES_DIR%|${gcodes_dir}|" "${cfg}"
     ok_msg "Minimal example printer.cfg created!"
   else
     error_msg "Couldn't create minimal example printer.cfg!"
@@ -625,3 +630,34 @@ function get_klipper_python_ver() {
   version=$("${KLIPPY_ENV}"/bin/python --version 2>&1 | cut -d" " -f2 | cut -d"." -f1)
   echo "${version}"
 }
+
+function mask_disrupting_services() {
+  local brltty="false"
+  local brltty_udev="false"
+  local modem_manager="false"
+
+  [[ $(dpkg -s brltty  2>/dev/null | grep "Status") = *\ installed ]] && brltty="true"
+  [[ $(dpkg -s brltty-udev  2>/dev/null | grep "Status") = *\ installed ]] && brltty_udev="true"
+  [[ $(dpkg -s ModemManager  2>/dev/null | grep "Status") = *\ installed ]] && modem_manager="true"
+
+  status_msg "Installed brltty package detected, masking brltty service ..."
+  if [[ ${brltty} == "true" ]]; then
+    sudo systemctl stop brltty
+    sudo systemctl mask brltty
+  fi
+  ok_msg "brltty service masked!"
+
+  status_msg "Installed brltty-udev package detected, masking brltty-udev service ..."
+  if [[ ${brltty_udev} == "true" ]]; then
+    sudo systemctl stop brltty-udev
+    sudo systemctl mask brltty-udev
+  fi
+  ok_msg "brltty-udev service masked!"
+
+  status_msg "Installed ModemManager package detected, masking ModemManager service ..."
+  if [[ ${modem_manager} == "true" ]]; then
+    sudo systemctl stop ModemManager
+    sudo systemctl mask ModemManager
+  fi
+  ok_msg "ModemManager service masked!"
+}

scripts/klipperscreen.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -119,6 +119,8 @@ function update_klipperscreen() {
   old_md5=$(md5sum "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt" | cut -d " " -f1)
 
   do_action_service "stop" "KlipperScreen"
+  backup_before_update "klipperscreen"
+
   cd "${KLIPPERSCREEN_DIR}"
   git pull origin master -q && ok_msg "Fetch successfull!"
   git checkout -f master && ok_msg "Checkout successfull"

scripts/mainsail.sh

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

scripts/mjpg-streamer.sh

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

scripts/mobileraker.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -61,8 +61,8 @@ function mobileraker_setup() {
     exit 1
   fi
 
-  status_msg "Installing Mobileraker's companion ..."
-  if "${MOBILERAKER_DIR}"/scripts/install-mobileraker-companion.sh; then
+  status_msg "Starting installer of Mobileraker's companion ..."
+  if "${MOBILERAKER_DIR}"/scripts/install.sh; then
     ok_msg "Mobileraker's companion successfully installed!"
   else
     print_error "Mobileraker's companion installation failed!"
@@ -233,7 +233,7 @@ primary_branch:main
 managed_services: mobileraker
 env: ${HOME}/mobileraker-env/bin/python
 requirements: scripts/mobileraker-requirements.txt
-install_script: scripts/install-mobileraker-companion.sh
+install_script: scripts/install.sh
 MOONRAKER_CONF
 
     fi

scripts/moonraker-telegram-bot.sh

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

scripts/moonraker.sh

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

scripts/nginx.sh

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

scripts/obico.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -63,7 +63,7 @@ function obico_server_url_prompt() {
 }
 
 function moonraker_obico_setup_dialog() {
-  status_msg "Initializing Moonraker-obico installation ..."
+  status_msg "Initializing Obico installation ..."
 
   local moonraker_count
   local moonraker_names
@@ -73,7 +73,7 @@ function moonraker_obico_setup_dialog() {
   if (( moonraker_count == 0 )); then
     ### return early if moonraker is not installed
     local error="Moonraker not installed! Please install Moonraker first!"
-    log_error "Moonraker-obico setup started without Moonraker being installed. Aborting setup."
+    log_error "Obico setup started without Moonraker being installed. Aborting setup."
     print_error "${error}" && return
   elif (( moonraker_count > 1 )); then
     # moonraker_names is valid only in case of multi-instance
@@ -90,10 +90,10 @@ function moonraker_obico_setup_dialog() {
   if (( allowed_moonraker_obico_count == 0 && moonraker_count > 0 )) && [[ $(get_moonraker_obico_status) != "Not linked!" ]]; then
     local yn
     while true; do
-      echo "${yellow}Obico for Klipper is already installed.${white}"
+      echo "${yellow}Obico is already installed.${white}"
       echo "It is safe to run the install again to repair any issues."
       echo ""
-      local question="Do you want to reinstall Obico for Klipper?"
+      local question="Do you want to reinstall Obico?"
       read -p "${cyan}###### ${question} (Y/n):${white} " yn
       case "${yn}" in
         Y|y|Yes|yes|"")
@@ -101,7 +101,7 @@ function moonraker_obico_setup_dialog() {
           break;;
         N|n|No|no)
           select_msg "No"
-          abort_msg "Exiting Obico for Klipper installation...\n"
+          abort_msg "Exiting Obico installation...\n"
           return;;
         *)
           error_msg "Invalid Input!";;
@@ -126,31 +126,30 @@ function moonraker_obico_setup_dialog() {
       done
       blank_line
       if (( existing_moonraker_obico_count > 0 )); then
-        printf "|${green}%-55s${white}|\n" " ${existing_moonraker_obico_count} Moonraker-obico instances already installed!"
+        printf "|${green}%-55s${white}|\n" " ${existing_moonraker_obico_count} Obico instances already installed!"
         for svc in ${moonraker_obico_services}; do
           printf "|${cyan}%-57s${white}|\n" " ● moonraker-obco-$(get_instance_name "${svc}")"
         done
       fi
       blank_line
-      echo -e "| The setup will apply the same names to                |"
-      echo -e "| Moonraker-obico!                                      |"
+      echo -e "| The setup will apply the same names to Obico!         |"
       blank_line
-      echo -e "| Please select the number of Moonraker-obico instances |"
-      echo -e "| to install. Usually one Moonraker-obico instance per  |"
+      echo -e "| Please select the number of Obico instances           |"
+      echo -e "| to install. Usually one Obico instance per            |"
       echo -e "| Moonraker instance is required, but you may not       |"
-      echo -e "| install more Moonraker-obico instances than available |"
+      echo -e "| install more Obico instances than available           |"
       echo -e "| Moonraker instances.                                  |"
       bottom_border
 
       ### ask for amount of instances
       local re="^[1-9][0-9]*$"
       while [[ ! ${new_moonraker_obico_count} =~ ${re} || ${new_moonraker_obico_count} -gt ${allowed_moonraker_obico_count} ]]; do
-        read -p "${cyan}###### Number of new Moonraker-obico instances to set up:${white} " -i "${allowed_moonraker_obico_count}" -e new_moonraker_obico_count
+        read -p "${cyan}###### Number of new Obico instances to set up:${white} " -i "${allowed_moonraker_obico_count}" -e new_moonraker_obico_count
         ### break if input is valid
         [[ ${new_moonraker_obico_count} =~ ${re} && ${new_moonraker_obico_count} -le ${allowed_moonraker_obico_count} ]] && break
         ### conditional error messages
         [[ ! ${new_moonraker_obico_count} =~ ${re} ]] && error_msg "Input not a number"
-        (( new_moonraker_obico_count > allowed_moonraker_obico_count )) && error_msg "Number of Moonraker-obico instances larger than installed Moonraker instances"
+        (( new_moonraker_obico_count > allowed_moonraker_obico_count )) && error_msg "Number of Obico instances larger than installed Moonraker instances"
       done && select_msg "${new_moonraker_obico_count}"
     else
       log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grather than one!"
@@ -160,8 +159,8 @@ function moonraker_obico_setup_dialog() {
     ### Step 2: Confirm instance amount
     local yn
     while true; do
-      (( new_moonraker_obico_count == 1 )) && local question="Install Moonraker-obico?"
-      (( new_moonraker_obico_count > 1 )) && local question="Install ${new_moonraker_obico_count} Moonraker-obico instances?"
+      (( new_moonraker_obico_count == 1 )) && local question="Install Obico?"
+      (( new_moonraker_obico_count > 1 )) && local question="Install ${new_moonraker_obico_count} Obico instances?"
       read -p "${cyan}###### ${question} (Y/n):${white} " yn
       case "${yn}" in
         Y|y|Yes|yes|"")
@@ -169,7 +168,7 @@ function moonraker_obico_setup_dialog() {
           break;;
         N|n|No|no)
           select_msg "No"
-          abort_msg "Exiting Moonraker-obico setup ...\n"
+          abort_msg "Exiting Obico setup ...\n"
           return;;
         *)
           error_msg "Invalid Input!";;
@@ -191,8 +190,8 @@ function moonraker_obico_setup_dialog() {
       fi
     done
 
-    (( new_moonraker_obico_count > 1 )) && status_msg "Installing ${new_moonraker_obico_count} Moonraker-obico instances ..."
-    (( new_moonraker_obico_count == 1 )) && status_msg "Installing Moonraker-obico ..."
+    (( new_moonraker_obico_count > 1 )) && status_msg "Installing ${new_moonraker_obico_count} Obico instances ..."
+    (( new_moonraker_obico_count == 1 )) && status_msg "Installing Obico ..."
 
     ### Step 5: Clone the moonraker-obico repo
     clone_moonraker_obico "${MOONRAKER_OBICO_REPO}"
@@ -244,17 +243,16 @@ function moonraker_obico_setup_dialog() {
   if (( ${#not_linked_instances[@]} > 0 )); then
     top_border
     if (( moonraker_count == 1 )); then
-      printf "|${green}%-55s${white}|\n" " Moonraker-obico not linked to the server!"
+      printf "|${green}%-55s${white}|\n" " Obico not linked to the server!"
     else
-      printf "|${green}%-55s${white}|\n" " ${#not_linked_instances[@]} Moonraker-obico instances not linked to the server!"
+      printf "|${green}%-55s${white}|\n" " ${#not_linked_instances[@]} Obico instances not linked to the server!"
       for i in "${not_linked_instances[@]}"; do
         printf "|${cyan}%-57s${white}|\n" " ● moonraker-obico-${moonraker_names[${i}]}"
       done
     fi
     blank_line
-    echo -e "| To link to your Obico Server account, you need to     |"
-    echo -e "| obtain the 6-digit verification code in the Obico     |"
-    echo -e "| mobile or web app. For more information, visit:       |"
+    echo -e "| It will take only 10 seconds to link printer to Obico.|"
+    echo -e "| For more information, visit:                          |"
     echo -e "| https://www.obico.io/docs/user-guides/klipper-setup/  |"
     blank_line
     echo -e "| If you don't want to link the printer now, you can    |"
@@ -272,7 +270,7 @@ function moonraker_obico_setup_dialog() {
           break;;
         N|n|No|no)
           select_msg "No"
-          abort_msg "Exiting Moonraker-obico setup ...\n"
+          abort_msg "Exiting Obico setup ...\n"
           return;;
         *)
           error_msg "Invalid Input!";;
@@ -295,13 +293,13 @@ function moonraker_obico_setup_dialog() {
 function clone_moonraker_obico() {
   local repo=${1}
 
-  status_msg "Cloning Moonraker-obico from ${repo} ..."
-  ### force remove existing Moonraker-obico dir
+  status_msg "Cloning Obico from ${repo} ..."
+  ### force remove existing Obico dir
   [[ -d "${MOONRAKER_OBICO_DIR}" ]] && rm -rf "${MOONRAKER_OBICO_DIR}"
 
   cd "${HOME}" || exit 1
   if ! git clone "${repo}" "${MOONRAKER_OBICO_DIR}"; then
-    print_error "Cloning Moonraker-obico from\n ${repo}\n failed!"
+    print_error "Cloning Obico from\n ${repo}\n failed!"
     exit 1
   fi
 }
@@ -316,7 +314,7 @@ function moonraker_obico_install() {
 
 function remove_moonraker_obico_systemd() {
   [[ -z $(moonraker_obico_systemd) ]] && return
-  status_msg "Removing Moonraker-obico Systemd Services ..."
+  status_msg "Removing Obico Systemd Services ..."
 
   for service in $(moonraker_obico_systemd | cut -d"/" -f5); do
     status_msg "Removing ${service} ..."
@@ -329,7 +327,7 @@ function remove_moonraker_obico_systemd() {
   ### reloading units
   sudo systemctl daemon-reload
   sudo systemctl reset-failed
-  ok_msg "Moonraker-obico Services removed!"
+  ok_msg "Obico Services removed!"
 }
 
 function remove_moonraker_obico_logs() {
@@ -361,7 +359,7 @@ function remove_legacy_moonraker_obico_logs() {
 function remove_moonraker_obico_dir() {
   [[ ! -d ${MOONRAKER_OBICO_DIR} ]] && return
 
-  status_msg "Removing Moonraker-obico directory ..."
+  status_msg "Removing Obico directory ..."
   rm -rf "${MOONRAKER_OBICO_DIR}"
   ok_msg "Directory removed!"
 }
@@ -380,7 +378,7 @@ function remove_moonraker_obico() {
   remove_moonraker_obico_dir
   remove_moonraker_obico_env
 
-  print_confirm "Moonraker-obico was successfully removed!"
+  print_confirm "Obico was successfully removed!"
   return
 }
 
@@ -394,7 +392,7 @@ function update_moonraker_obico() {
   if [[ ! -d ${MOONRAKER_OBICO_DIR} ]]; then
     clone_moonraker_obico "${MOONRAKER_OBICO_REPO}"
   else
-    status_msg "Updating Moonraker-obico ..."
+    status_msg "Updating Obico ..."
     cd "${MOONRAKER_OBICO_DIR}" && git pull
   fi
 

scripts/octoeverywhere.sh

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

scripts/octoprint.sh

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

scripts/pretty_gcode.sh

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

scripts/rollback.sh

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

scripts/switch_klipper_repo.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -77,10 +77,12 @@ function change_klipper_repo_menu() {
               error_msg "Invalid command!";;
           esac
         done
+        break
       else
         status_msg "Set custom Klipper repository to:\n       ● Repository: ${repos[${option}]}\n       ● Branch: ${branches[${option}]}"
         set_custom_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
         ok_msg "This repo will now be used for new Klipper installations!\n"
+        break
       fi
 
     elif [[ ${option} =~ ${back} ]]; then

scripts/ui/advanced_menu.sh

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

scripts/ui/backup_menu.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -25,7 +25,7 @@ function backup_ui() {
   echo -e "|                            |                          |"
   echo -e "| Klipper Webinterface:      | Other:                   |"
   echo -e "|  5) [Mainsail]             |  9) [Telegram Bot]       |"
-  echo -e "|  6) [Fluidd]               |                          |"
+  echo -e "|  6) [Fluidd]               | 10) [OctoEverywhere]     |"
   back_footer
 }
 
@@ -54,6 +54,8 @@ function backup_menu() {
         do_action "backup_octoprint" "backup_ui";;
       9)
         do_action "backup_telegram_bot" "backup_ui";;
+      10)
+        do_action "backup_octoeverywhere" "backup_ui";;
       B|b)
         clear; main_menu; break;;
       *)

scripts/ui/general_ui.sh

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

scripts/ui/install_menu.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -35,7 +35,7 @@ function install_ui() {
 }
 
 function install_menu() {
-  clear -x && sudo -v && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
+  clear -x && sudo true && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
   print_header
   install_ui
 

scripts/ui/main_menu.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -57,7 +57,7 @@ function print_status() {
   elif [[ ${status} == "Incomplete!" ]]; then
     status="${yellow}${status}${white}"
   elif [[ ${status} == "Not linked!" ]]; then
-    ### "Not linked!" is only required for Moonraker-obico
+    ### "Not linked!" is only required for Obico for Klipper
     status="${yellow}${status}${white}"
   else
     status="${green}${status}${white}"

scripts/ui/remove_menu.sh

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

scripts/ui/settings_menu.sh

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

scripts/ui/update_menu.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -41,7 +41,7 @@ function update_ui() {
 }
 
 function update_menu() {
-  clear -x && sudo -v && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
+  clear -x && sudo true && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
   do_action "" "update_ui"
   
   local action

scripts/upload_log.sh

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

scripts/utilities.sh

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