Merge 6c81ba2232 into 195b7fa926

* Add moonraker-hmi and moonraker-telegram-bot to the blacklist of moonraker service detection function

* fix: add "hmi" to SUFFIX_BLACKLIST to prevent instance name conflicts

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

---------

Signed-off-by: Dominik Willner <th33xitus@gmail.com>
Co-authored-by: dw-0 <th33xitus@gmail.com>

.vs/ProjectSettings.json

@@ -0,0 +1,3 @@
+{
+  "CurrentProjectSetting": null
+}

.vs/VSWorkspaceState.json

@@ -0,0 +1,11 @@
+{
+  "ExpandedNodes": [
+    "",
+    "\\kiauh",
+    "\\kiauh\\components\\droidklipp",
+    "\\kiauh\\core",
+    "\\kiauh\\core\\menus"
+  ],
+  "SelectedNode": "\\kiauh\\core\\menus\\main_menu.py",
+  "PreviewInSolutionExplorer": false
+}

README.md

@@ -71,14 +71,14 @@ sudo apt-get update && sudo apt-get install git -y
 Once git is installed, use the following command to download KIAUH into your home-directory:
 
 ```shell
-cd ~ && git clone https://github.com/dw-0/kiauh.git
+cd ~ && git clone https://github.com/CodeMasterCody3D/kiauhPlusDroidKlipp.git
 ```
 
 * **Step 3:** \
 Finally, start KIAUH by running the next command:
 
 ```shell
-./kiauh/kiauh.sh
+./kiauhPlusDroidKlipp/kiauh.sh
 ```
 
 * **Step 4:** \

kiauh/components/droidklipp/droidklipp.py

@@ -0,0 +1,47 @@
+import os
+import subprocess
+
+def install_droidklipp():
+    try:
+        print("Are you sure you want to install DroidKlipp? (Y/N)")
+        user_confirmation = input().strip().lower()
+
+        if user_confirmation != 'y':
+            print("DroidKlipp installation aborted.")
+            return
+
+        print("Installing DroidKlipp...")
+        subprocess.run(['sudo', 'apt', 'install', '-y', 'adb', 'tmux'], check=True)
+
+        # Define the DroidKlipp repository URL and directory
+        droidklipp_repo_url = "https://github.com/CodeMasterCody3D/DroidKlipp.git"
+        droidklipp_dir = os.path.expanduser('~/DroidKlipp')
+
+        # Check if DroidKlipp directory exists, if not create it
+        if not os.path.isdir(droidklipp_dir):
+            print("DroidKlipp folder not found, creating directory...")
+            os.makedirs(droidklipp_dir)
+
+        # Clone the repository if not already cloned
+        if not os.path.isdir(os.path.join(droidklipp_dir, '.git')):
+            print("Cloning the DroidKlipp repository...")
+            subprocess.run(['git', 'clone', droidklipp_repo_url, droidklipp_dir], check=True)
+        else:
+            print("DroidKlipp repository already exists.")
+
+        # Change to the DroidKlipp directory
+        os.chdir(droidklipp_dir)
+
+        # Set executable permissions for the installation script
+        subprocess.run(['sudo', 'chmod', '+x', 'droidklipp.sh'], check=True)
+
+        # Run the installation script
+        subprocess.run(['./droidklipp.sh'], check=True)
+
+        print("DroidKlipp installation complete!")
+    except subprocess.CalledProcessError as e:
+        print(f"Error during installation: {e}")
+    except Exception as e:
+        print(f"Unexpected error: {e}")
+
+# Ensure you call this with proper confirmation before installation

kiauh/core/instance_manager/base_instance.py

@@ -16,8 +16,9 @@ from typing import List
 
 from utils.fs_utils import get_data_dir
 
-SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
-
+# suffixes that are not allowed to be used for instances
+# because they would cause conflicts with other components or are reserved
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion", "hmi"]
 
 @dataclass(repr=True)
 class BaseInstance:

kiauh/core/menus/install_menu.py

@@ -11,6 +11,7 @@ from __future__ import annotations
 import textwrap
 from typing import Type
 
+from components.droidklipp.droidklipp import install_droidklipp
 from components.crowsnest.crowsnest import install_crowsnest
 from components.klipper.services.klipper_setup_service import KlipperSetupService
 from components.klipperscreen.klipperscreen import install_klipperscreen
@@ -41,7 +42,6 @@ class InstallMenu(BaseMenu):
 
     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:
@@ -53,7 +53,9 @@ class InstallMenu(BaseMenu):
             "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),
+            "8": Option(method=self.install_droidklipp),  # Add DroidKlipp option
+            "9": Option(method=self.install_crowsnest),
+            
         }
 
     def print_menu(self) -> None:
@@ -62,15 +64,17 @@ class InstallMenu(BaseMenu):
             ╟───────────────────────────┬───────────────────────────╢
             ║ Firmware & API:           │ Touchscreen GUI:          ║
             ║  1) [Klipper]             │  7) [KlipperScreen]       ║
-            ║  2) [Moonraker]           │                           ║
+            ║  2) [Moonraker]           │  8) [DroidKlipp]          ║
+            ║                           │                           ║
             ║                           │ Webcam Streamer:          ║
-            ║ Webinterface:             │  8) [Crowsnest]           ║
+            ║ Webinterface:             │  9) [Crowsnest]           ║
             ║  3) [Mainsail]            │                           ║
             ║  4) [Fluidd]              │                           ║
             ║                           │                           ║
             ║ Client-Config:            │                           ║
             ║  5) [Mainsail-Config]     │                           ║
             ║  6) [Fluidd-Config]       │                           ║
+            ║                           │                           ║ 
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
@@ -107,3 +111,6 @@ class InstallMenu(BaseMenu):
 
     def install_crowsnest(self, **kwargs) -> None:
         install_crowsnest()
+
+    def install_droidklipp(self, **kwargs) -> None:
+        install_droidklipp()

kiauh/core/menus/main_menu.py

@@ -12,6 +12,7 @@ import sys
 import textwrap
 from typing import Callable, Type
 
+from components.droidklipp.droidklipp import install_droidklipp
 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

kiauh/extensions/extensions_menu.py

@@ -150,9 +150,9 @@ class ExtensionSubmenu(BaseMenu):
         if website or repo:
             links_lines: List[str] = ["Links:"]
             if website:
-                links_lines.append(f"- Website: {website}")
+                links_lines.append(f"● {website}")
             if repo:
-                links_lines.append(f"- GitHub: {repo}")
+                links_lines.append(f"● {repo}")
 
             links_text = Logger.format_content(
                 links_lines,

kiauh/extensions/gcode_shell_cmd/metadata.json

@@ -4,6 +4,7 @@
     "module": "gcode_shell_cmd_extension",
     "maintained_by": "dw-0",
     "display_name": "G-Code Shell Command",
-    "description": ["Run a shell commands from gcode."]
+    "description": ["Run a shell commands from gcode."],
+    "updates": false
   }
 }

kiauh/extensions/klipper_backup/metadata.json

@@ -5,6 +5,8 @@
     "maintained_by": "Staubgeborener",
     "display_name": "Klipper-Backup",
     "description": ["Backup all your Klipper files to GitHub"],
+    "website": "https://klipperbackup.xyz",
+    "repo": "https://github.com/Staubgeborener/klipper-backup",
     "updates": true
   }
 }

kiauh/extensions/mainsail_theme_installer/metadata.json

@@ -4,6 +4,8 @@
     "module": "mainsail_theme_installer_extension",
     "maintained_by": "dw-0",
     "display_name": "Mainsail Theme Installer",
-    "description": ["Install Mainsail Themes maintained by the Mainsail community."]
+    "description": ["Install Mainsail Themes maintained by the Mainsail community."],
+    "website": "https://docs.mainsail.xyz/theming/themes",
+    "updates": false
   }
 }

kiauh/extensions/mobileraker/metadata.json

@@ -7,6 +7,7 @@
         "description": [
             "Companion for Mobileraker, enabling push notification for Klipper using Moonraker."
         ],
+        "repo": "https://github.com/Clon1998/mobileraker_companion",
         "updates": true
     }
 }

kiauh/extensions/obico/metadata.json

@@ -11,6 +11,8 @@
         "- 25FPS High-Def Webcam Streaming",
         "- Free 4.9-Star Mobile App"
     ],
+    "website": "https://obico.io",
+    "repo": "github.com/TheSpaghettiDetective/moonraker-obico",
     "updates": true
   }
 }

kiauh/extensions/octoapp/metadata.json

@@ -12,6 +12,7 @@
             "- Live Gcode preview",
             "- And much much more!"
         ],
+        "repo": "https://github.com/crysxd/OctoApp-Plugin",
         "updates": true
     }
 }

kiauh/extensions/octoeverywhere/metadata.json

@@ -11,6 +11,8 @@
             "- Real-time Notifications",
             "- Live Streaming, and More!"
         ],
+        "website": "https://octoeverywhere.com",
+        "repo": "github.com/QuinnDamerell/OctoPrint-OctoEverywhere",
         "updates": true
     }
 }

kiauh/extensions/pretty_gcode/metadata.json

@@ -5,6 +5,7 @@
     "maintained_by": "Kragrathea",
     "display_name": "PrettyGCode for Klipper",
     "description": ["3D G-Code viewer for Klipper"],
+    "repo": "https://github.com/Kragrathea/pgcode",
     "updates": true
   }
 }

kiauh/extensions/simply_print/metadata.json

@@ -1,13 +1,16 @@
 {
-    "metadata": {
-        "index": 10,
-        "module": "simply_print_extension",
-        "maintained_by": "dw-0",
-        "display_name": "SimplyPrint",
-        "description": [
-            "3D Printer Cloud Management Software.",
-            "\n\n",
-            "3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
-        ]
-    }
+  "metadata": {
+    "index": 10,
+    "module": "simply_print_extension",
+    "maintained_by": "dw-0",
+    "display_name": "SimplyPrint",
+    "description": [
+      "3D Printer Cloud Management Software.",
+      "\n\n",
+      "3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
+    ],
+    "website": "https://simplyprint.io",
+    "repo": "https://github.com/SimplyPrint",
+    "updates": false
+  }
 }

kiauh/extensions/spoolman/metadata.json

@@ -13,6 +13,7 @@
       "\n\n",
       "Note: This extension installs Spoolman using Docker. Docker must be installed on your system before installing Spoolman."
     ],
+    "repo": "https://github.com/Donkie/Spoolman",
     "updates": true
   }
 }

kiauh/extensions/telegram_bot/metadata.json

@@ -5,7 +5,7 @@
     "maintained_by": "nlef",
     "display_name": "Moonraker Telegram Bot",
     "description": ["Control your printer with the Telegram messenger app."],
-    "project_url": "https://github.com/nlef/moonraker-telegram-bot",
+    "repo": "https://github.com/nlef/moonraker-telegram-bot",
     "updates": true
   }
 }

kiauh/utils/common.py

@@ -9,6 +9,8 @@
 
 from __future__ import annotations
 
+from components.droidklipp.droidklipp import install_droidklipp
+
 import re
 from datetime import datetime
 from pathlib import Path
@@ -42,10 +44,13 @@ from utils.sys_utils import (
 def get_kiauh_version() -> str:
     """
     Helper method to get the current KIAUH version by reading the latest tag
-    :return: string of the latest tag
+    :return: string of the latest tag or a default value if no tags exist
     """
-    lastest_tag: str = get_local_tags(Path(__file__).parent.parent)[-1]
-    return lastest_tag
+    tags = get_local_tags(Path(__file__).parent.parent)
+    if tags:
+        return tags[-1]
+    else:
+        return "v?.?.?"
 
 
 def convert_camelcase_to_kebabcase(name: str) -> str:

scripts/moonraker.sh

@@ -27,7 +27,7 @@ function moonraker_systemd() {
   ###
   # any moonraker client that uses "moonraker" in its own name must be blacklisted using
   # this variable, otherwise they will be falsely recognized as moonraker instances
-  blacklist="obico"
+  blacklist="obico|hmi|telegram-bot"
 
   ignore="${SYSTEMD}/moonraker-(${blacklist}).service"
   match="${SYSTEMD}/moonraker(-[0-9a-zA-Z]+)?.service"