Skip to content

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

License

Notifications You must be signed in to change notification settings

adec/guppyscreen

 
 

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/ballaswag/guppyscreen/main/installer.sh)"

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

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

Uninstall

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

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

Install on aarch64 (Debian Bullseye) - Experimental

Tested on a BTT Pad 7. Please install with care and make sure you're okay with resetting your setup if things break.

wget -O - https://raw.githubusercontent.com/ballaswag/guppyscreen/main/installer-deb.sh | bash

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.

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/

Support Guppy Screen

You can directly support this project by Buy Me a Coffee at ko-fi.com or

Credits

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

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 98.5%
  • C++ 1.0%
  • Python 0.3%
  • Makefile 0.2%
  • Shell 0.0%
  • AIDL 0.0%