Skip to content
 
 

Repository files navigation

Guppy Screen for Klipper

Guppy Screen is a touch UI for Klipper using APIs exposed by Moonraker. It builds on LVGL as a standalone executable, has no dependency on any display servers such as X/Wayland.

Installation / Update

Run the following interactive script via SSH on your K1/Max/CR-10 SE/Ender 3 V3 KE/Nebula Pad to install Guppy Screen.

Material Design Theme

sh -c "$(wget --no-check-certificate -qO - https://raw.githubusercontent.com/PyCos/guppyscreen-probielodan/main/scripts/installer.sh)"

Z-Bolt Theme (Only for the K1/Max)

sh -c "$(wget --no-check-certificate -qO - https://raw.githubusercontent.com/PyCos/guppyscreen-probielodan/main/scripts/installer.sh)" -s zbolt

Nightly Builds

Material (Nightly)

sh -c "$(wget --no-check-certificate -qO - https://raw.githubusercontent.com/PyCos/guppyscreen-probielodan/main/scripts/installer.sh)" -s nightly

Z-Bolt (Nightly)

sh -c "$(wget --no-check-certificate -qO - https://raw.githubusercontent.com/PyCos/guppyscreen-probielodan/main/scripts/installer.sh)" -s zbolt nightly

Raspbian Variant (Nightly)

wget -O - https://raw.githubusercontent.com/PyCos/guppyscreen-probielodan/main/scripts/installer-deb.sh | bash -s nightly

Uninstall

ssh into your K1/Max and run the following command:

/usr/data/guppyscreen/reinstall-creality.sh

Features

✅ Console/Macro Shell
✅ Bedmesh
✅ Input Shaper (PSD graphs)
✅ Belt Calibration/Excitate
✅ Print Status
✅ Spoolman Integration
✅ Extrude/Retract
✅ Temperature Control
✅ Fans/LED/Move Control
✅ Fine Tune (speed, flow, z-offset, Pressure Advance)
✅ Limits (Velocity, Acel, Square Corner Velocity, etc.)
✅ File Browser
✅ Supports multiple screen resolutions
✅ Cross platform releases (MIPS/ARM/x86)
✅ TMC Metrics
✅ Multi-Printer support

Roadmap

‼️ Exclude Object
‼️ Firmware Retraction

Open for feature requests.

Documentation

You can find various Guppy Screen documents here.

Screenshot

Material Theme

Material Theme Guppy Screen

Earlier development screenshots can be found here

Video Demo

https://www.reddit.com/r/crealityk1/comments/17jp59g/new_touch_ui_for_the_k1/

Credits

Guppyscreen | Material Design Icons | Z-Bolt Icons | Moonraker | KlipperScreen | Fluidd | Klippain-shaketune

About

A native Touch UI for 3D Printers running Klipper/Moonraker.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages