Update README.md

This commit is contained in:
th33xitus
2020-09-13 12:11:52 +02:00
committed by GitHub
parent 125eea921f
commit ecd9e7f489

View File

@@ -31,6 +31,30 @@ chmod +x kiauh.sh scripts/*
./kiauh.sh
```
---
## Functions and Features:
### Core Functions:
- **Installing** of the Klipper Firmware to your Raspberry Pi or other Linux Distribution which makes use of init.d.
- **Installing** of several different web interfaces such as Duet Web Control, Mainsail or OctoPrint including their dependencies.
- **Installing** of the Moonraker API
- **Updating** of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface!
- **Removing** of all the listed installations above.
- **Backup** of all the listed installationes above.
What also is possible:
- Build the Klipper Firmware
- Flash the MCU
- Read ID of the currently connected printer (only one at the time)
- Write necessary entries to your printer.cfg, some of them customizable right in the CLI.
For a list of additional features and their descriptions please see:
[Feature List](https://github.com/th33xitus/kiauh/edit/work-13092020/docs/features.md)
---
## Notes:
- Tested only on Raspbian Buster Lite
@@ -74,60 +98,8 @@ OctoPrint Webinterface by [OctoPrint](https://github.com/OctoPrint) :
---
## Functions and Features:
### Core Functions:
- **Install:** Klipper Firmware, dwc2-for-klipper-socket + Duet Web Control, Moonraker + Mainsail, OctoPrint
- **Update:** Klipper Firmware, dwc2-for-klipper-socket + Duet Web Control, Moonraker + Mainsail
- **Backup:** Klipper Firmware, dwc2-for-klipper-socket + Duet Web Control, Moonraker + Mainsail, OctoPrint
- **Remove:** Klipper Firmware, dwc2-for-klipper-socket + 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?_**
**A:** ~~Soon™~~ Yes :)
**_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 . Keep in mind that klipper-DWC2-installer and KIAUH are **NOT** compatible with each other.