jeka/kiauh
1
0
Fork 0
mirror of https://github.com/dw-0/kiauh.git synced 2025-12-11 17:44:28 +05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev-2.0'

Browse Source
This commit is contained in:
th33xitus
2020-07-29 15:48:47 +02:00
parent b4496603ed fce1eb5a8c
commit b6c07fc357
23 changed files with 2584 additions and 805 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
README.md
View File

@@ -2,54 +2,93 @@
## Klipper Installation And Update Helper
This script was actually created for my personal use only but i then decided to make the script accessible for everyone.
It is meant to help guiding you through a complete fresh install of Klipper and optionally the DWC2 web UI + DWC2-for-Klipper.
There are also functions for updating your current installations or removing them from your system.
### ( THIS VERSION IS STILL WORK IN PROGRESS! )
## First things first: When you decide to use this script, you use it at your own risk!
![main_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/main.png)
![remove_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/remove.png)
![update_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/update.png)
![advanced_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/advanced.png)
Although i implemented backup-functions for pretty much everything and tested this script extensively with my available (yet limited) hardware before releasing it, it doesn't mean that it will work 100% perfect for everyone out there. Please keep that in mind!
## First things first: If you decide to use this script, be aware you are using it at your own risk!
Give it a try if you want and if you have suggestions or encounter any problems, please report them. But i can't guarantee that i will fix them immediately (or at all).
[![kiauh](https://abload.de/img/putty_20-05-22_18-49-1nkaa.png)](https://abload.de/image.php?img=putty_20-05-22_18-49-1nkaa.png)
Give it a try if you want and if you have suggestions or encounter any problems, please report them to me.
## Instructions:
If you don't have git already installed, please install it first:
`sudo apt-get install git -y`
After you made sure to have git installed, use the following commands in the given order to download and execute the script.
```
If you haven't git already installed on your machine run `sudo apt-get install git -y` to install git first. You will need it anyways!
After you have successfully installed git, use the following commands in the given order to download and execute the script.
```shell
cd ~
git clone https://github.com/th33xitus/kiauh.git
cd ~/kiauh
chmod +x kiauh.sh
cd kiauh
chmod +x ~/kiauh/kiauh.sh
chmod +x ~/kiauh/scripts/*
./kiauh.sh
```
## Restrictions:
* Tested only on Raspbian Buster Lite
## Notes:
## Functions and features:
* Install Klipper + DWC2-for-klipper + DWC2 from scratch
* Check the status of your installations
* Update, backup and remove existing installations
* Building firmware
* Flashing firmware to your MCU
* Grabbing the printer-ID of your connected printer
* Writing the printer-ID to your printer.cfg
* Writing the DWC2-for-Klipper example config to your printer.cfg
- Tested only on Raspbian Buster Lite
- During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.
- Prevent simultaneous use of DWC2 and OctoPrint if possible. There have been reports that DWC2 does strange things while the OctoPrint service is running while using the DWC2 webinterface. The script disables an existing OctoPrint service when installing DWC2. However, the service can also be reactivated with the script!
- If you used Mainsail v0.0.12 before and you want to upgrade to v0.1.0 or later, you have to reinstall Moonraker as well! Mainsail v0.1.0 will not work with the old Moonraker service. Don't worry, the script can handle the proper removal of the old version.
## Functions and Features:
### Core Functions:
- **Install:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail, OctoPrint
- **Update:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail
- **Backup:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail, OctoPrint
- **Remove:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail, OctoPrint
- Build Klipper Firmware
- Flash MCU
- Read ID of the currently connected printer (only one at the time)
- Write several entries to your printer.cfg, some of them customizable right in the console
- Before writing to an existing printer.cfg the script will create a backup! (better safe than sorry!)
### Features:
- Automatic dependency check:
- If packages are missing on your machine but needed for the asked task, the script will automatically install them
- Switch between Klipper Forks:
- [origin/master](https://github.com/KevinOConnor/klipper/tree/master), [scurve-shaping](https://github.com/dmbutyugin/klipper/tree/scurve-shaping), [scurve-smoothing](https://github.com/dmbutyugin/klipper/tree/scurve-smoothing), [moonraker](https://github.com/Arksine/klipper/tree/dev-moonraker-testing)
- The update function of the script will always update the currently selected/active fork!
- Toggle auto-create backups before updating:
- When enabled, a backup of the installation you want to update is made prior updating
- Preconfigure OctoPrint:
- When installing OctoPrint, a config is created which preconfigures your installation to be used with Klipper
- adding the restart/shutdown commands for OctoPrint
- adding the serial port `/tmp/printer`
- set the behavior to "Cancel any ongoing prints but stay connected to the printer"
- Enable/Disable OctoPrint Service:
- Usefull when using DWC2/Mainsail and OctoPrint at the same time to prevent them interfering with each other
- Set up reverse proxy for DWC2, Mainsail and OctoPrint and changing the hostname:
- The script can install and configure Nginx for the selected webinterface. This will allow you to make your webinterface reachable over an URL like `<hostname>.local`
- Example: If you name the host "mainsail" and set up a reverse proxy, type `mainsail.local` in your webbrowser to open the Mainsail webinterface
to be continued...
## What this script can't do:
- Updating OctoPrint -> Use OctoPrint for updating!
- Setting up webcam related stuff:
- If you want to use a webcam you have to install the dependencies and configurations yourself. I can't test this stuff sufficient enough due to me not having/using a webcam and therefore it's just too much work for me to set up an installation script which works, at best, with the first try.
There are install instructions (at least in case of OctoPrint) available:
[Setting up OctoPrint on a Raspberry Pi running Raspbian](https://community.octoprint.org/t/setting-up-octoprint-on-a-raspberry-pi-running-raspbian/2337)
(look for "Optional: Webcam")
## Q&A
__*Q: Can i install octoprint with this script?*__
**_Q: Can i install octoprint with this script?_**
**A:** No, and i don't plan to implement this function
**A:** ~~Soon™~~ Yes :)
**_Q: Can i use this script to install multiple instancec of Klipper on the same Pi? (Multisession?)_**
__*Q: Can i use this script to install multiple instancec of Klipper on the same Pi? (Multisession?)*__
**A:** No, and at the moment i don't plan to implement this function. For multisession installations take a look at this script manu7irl created: https://github.com/manu7irl/klipper-DWC2-installer
**A:** No, and at the moment i don't plan to implement this function. For multisession installations take a look at this script manu7irl created: https://github.com/manu7irl/klipper-DWC2-installer . Keep in mind that klipper-DWC2-installer and KIAUH are **NOT** compatible with each other.