Skip to content

broncosis/KiauhTC

 
 

Repository files navigation

KIAUH Logo

KiauhTC — Klipper Installation And Update Helper

with Toolchanger Kit support

A fork of KIAUH with extra extensions for multi-tool and multi-lane filament printers — toolchanger macros, filament feeders, Spoolman lane sync, USB camera setup, and more.



📄️ Instructions 📄

📋 Prerequisites

KIAUH is a script that assists you in installing Klipper on a Linux operating system that has already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure that you have a functional Linux system on hand. Raspberry Pi OS Lite (either 32bit or 64bit) is a recommended Linux image if you are using a Raspberry Pi. The official Raspberry Pi Imager is the simplest way to flash an image like this to an SD card.

  • Once you have downloaded, installed and launched the Raspberry Pi Imager, select Choose OS -> Raspberry Pi OS (other): \

KIAUH logo

  • Then select Raspberry Pi OS Lite (32bit) (or 64bit if you want to use that instead):

KIAUH logo

  • Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which you want to flash the image.

  • Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu) and enable SSH and configure Wi-Fi.

  • If you need more help for using the Raspberry Pi Imager, please visit the official documentation.

These steps only apply if you are actually using a Raspberry Pi. In case you want to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run and operate on the Linux Distribution you are going to flash. You likely will have the most success with distributions based on Debian 11 Bullseye. Read the notes further down below in this document.

💾 Download and use KIAUH

📢 Disclaimer: Usage of this script happens at your own risk!

  • Step 1:
    To download this script, it is necessary to have git installed. If you don't have git already installed, or if you are unsure, run the following command:
sudo apt-get update && sudo apt-get install git -y
  • Step 2:
    Once git is installed, use the following command to download KiauhTC into your home-directory:
cd ~ && git clone https://github.com/broncosis/KiauhTC.git kiauhtc
  • Step 3:
    Finally, start KiauhTC by running the next command:
./kiauhtc/KiauhTC.sh
  • Step 4:
    You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending on what you want to do. To choose an action, simply type the corresponding number into the "Perform action" prompt and confirm by hitting ENTER.

🔧 KiauhTC Extensions

All extensions below are found in the Extensions menu. They all register with Moonraker's update_manager so they can be updated from the Mainsail or Fluidd UI alongside Klipper.


Toolchanger Kit

Installs and manages multi-tool components for toolchanger printers.

Component What it does
klipper-toolchanger-easy Python extras + macros for tool-change sequences
Cartographer probe Klipper plugin for Cartographer eddy-current probes
Axiscope Tool alignment web service + Klipper module

During installation you will be asked which probe type you are using:

  • TAP — each tool has its own Z-probe. You will also be offered the option to roll Klipper back to a known-good commit, because several recent Klipper updates have broken tap-based probing.
  • Shuttle — a single probe is mounted on the toolhead carrier.

Klipper must be installed via KIAUH before running the Toolchanger Kit installer.


Klipper module for multi-lane filament feeding. Installs Python extras and symlinks them into Klipper's extras directory.


Syncs filament lane data to Spoolman. During installation, KiauhTC will check whether Spoolman is installed and suggest installing it first if it is not found.


Adds filament lane management panels to KlipperScreen. Requires KlipperScreen to be installed first.


Web UI for configuring USB cameras via v4l2 — browse and adjust camera controls (brightness, contrast, focus, exposure, etc.) from a browser. Runs as a lightweight systemd service; KiauhTC will check that v4l2-utils is installed and print the access URL when setup completes.


❗ Notes ❗

**📋 Please see the Changelog for possible important

changes!**

  • Mainly tested on Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye)
    • Other Debian based distributions (like Ubuntu 20 to 22) likely work too
    • Reported to work on Armbian as well but not tested in detail
  • During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.

⚙️ Core Components ⚙️

Klipper Logo Arksine avatar Mainsail Logo
by KevinOConnor by Arksine by mainsail-crew
Fluidd Logo KlipperScreen Logo
by fluidd-core by alfrix

🧩 Community Extensions 🧩

OctoPrint Logo nlef avatar Kragrathea avatar
by OctoPrint by nlef by Kragrathea
Obico logo Mobileraker Logo OctoEverywhere Logo
by Obico by Patrick Schmidt by Quinn Damerell
OctoApp Logo Staubgeroner Avatar SimplyPrint Logo
by Christian Würthner by Staubgeborener by SimplyPrint
DroidKlipp Logo Moongate Logo
by CodeMasterCody3D by PEEKYPAUL

🎖️ Contributors 🎖️


Repobeats analytics image

✨ Credits ✨

  • KiauhTC is a fork of KIAUH by dw-0 — all original credit goes to them and the KIAUH contributors.
  • Thank you to lixxbox for the KIAUH logo.
  • Thank you to jwellman80 for klipper-toolchanger-easy, Cartographer3D for the Cartographer Klipper plugin, and nic335 for Axiscope.
  • Also, a big thank you to everyone who supported dw-0's work with a Ko-fi !

About

Klipper Installation And Update Helper

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Python 99.4%
  • Shell 0.6%