Christian Kvasny 0b9d545c6f
add speed as parameter to UN/LOAD_FILAMENT macro (#359)
* Configurable xy position for z-calibrate added

* fix coding style

* Z probe calibrate option added

* add speed as parameter for UN/LOAD_FILAMENT macro

* add macros.md to docs

* update description

* change macros-md
fix format

Co-authored-by: jordanruthe <31575189+jordanruthe@users.noreply.github.com>
2021-12-18 09:38:33 -05:00

30 lines
1.3 KiB
Markdown

# KlipperScreen
KlipperScreen is a touchscreen GUI that interfaces with [Klipper](https://github.com/kevinOConnor/klipper) via [Moonraker](https://github.com/arksine/moonraker). It can switch between multiple printers to access them from a single location, and it doesn't even need to run on the same host, you can install it on another device and configure the IP address to access the printer.
### Required Hardware
KlipperScreen should run on any touchscreen that you can connect to a host (Raspberry, PC, Tablet), but not screens that connect directly to the printer MCU board.
A physical touchscreen is not strictly required, for example you may install a remote desktop server like tigervnc-scraping-server and connect from a client device, ![check out the hardware page for further information.](Hardware.md)
### Sample Panels
Main Menu
![Main Menu](img/main_panel.png)
Job Status
![Job Status](img/job_status.png)
[More](panels.md)
### Supported Macros
[More](macros.md)
### Inspiration
KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that
will natively work with [Klipper](https://github.com/klipper3d/klipper) and [Moonraker](https://github.com/arksine/moonraker).
[Changelog](changelog.md)