Releases: coreflake1/guppyscreen
v1.1.0-OpenKE
Headline: the buzzer now makes real sound — pitched beeps and songs (zero-CPU, print-safe) — plus a soft touchscreen click. Also fixes the H.264 camera breaking when the printer's IP changes.
Added
- Buzzer beeps & songs (hardware PWM) — the onboard piezo plays real pitches via hardware PWM (zero CPU, safe to use mid-print).
M300 S<freq> P<ms>— the standard slicer beep, now with real pitch and duration.PLAY_TUNE SONG=<name>— play songs from an editablesongs.conf(ships with mario / zelda / starwars + success / error jingles; add your own RTTTL tunes; the file is preserved across reinstalls).PLAY_TUNE RTTTL=<string>plays a one-off.BEEP— a quick confirmation chirp.
- Soft touchscreen click — optional, phone-style tap feedback (Settings → Touch Beep, default off); far quieter and lower than the stock beep.
- Link to a 3D-printable screen mount (Thingiverse #6617266).
Changed
M300is now a real hardware-PWM tone (itsS/Pparameters finally matter) instead of a fixed-pitch buzz.- Change history now lives here on the Releases page (in-repo release notes removed).
Fixed
- H.264 camera survives IP changes — the Nebula (go2rtc) webcam auto-refreshes its Moonraker URL to the current IP on every boot, so a DHCP/IP change no longer requires re-running the installer.
- Uninstall now removes
songs.conf. - Docs: clarified the wrong-sensor-labels fix (re-run the installer); new Beeps & Songs wiki page; updated camera/upgrade pages.
Upgrading from v1.0.0 or earlier: update the screen via Settings → Update Guppy, then re-run the installer once to pick up the new M300/PLAY_TUNE macros + songs.conf (the on-screen updater swaps the binary but not the Klipper config). See the Upgrading and Beeps & Songs wiki pages.
v1.0.0-OpenKE
First stable 1.0 release of OpenKE. The touch UI, the vendored print-quality mods, and a
self-contained one-shot installer now come together as a single package — and, from this release on,
every version is documented here. (Content-identical to the short-lived v0.6.0-OpenKE tag, which this
release supersedes.)
Added
- On-screen: stoppable filament Load (stops cleanly instead of running forever); an Invert Y
homing-jog toggle (bed-slinger feel); auto-cooldown of the hotend after a manual
extrude/retract/load/unload; a Spoolman "Use this filament?" confirmation before a manual load; and
a regrouped Tune tab + rebalanced Settings panel. - Guided on-screen input shaper — calibrates X/Y one axis at a time with an
accelerometer-placement confirmation before each axis (correct for the bed-slinger: toolhead for X, bed
for Y), locks Calibrate/Save while a run is in progress, shows progress and recommendation
toasts, presents the frequency-response graph + a readable console side-by-side, and has a watchdog
so a hung run can't spin forever. - Hardware H.264 camera stream (go2rtc) — a low-bandwidth WebRTC/RTSP feed for the Creality Nebula,
alongside the stock MJPEG. - Vendored Klipper mods under
k1/k1_mods/klipper_mods/(ship in the release tarball): KAMP
(adaptive mesh + purge, pre-edited for the KE), Axis Twist Compensation (Klipper v0.12.0 module +
idempotentprobe.pypatcher), and TMC Autotune (evgarthub K1 fork). Each carries its upstream
LICENSE/NOTICE; seedocs/VENDORING.md. No more cloning other repos by hand. - Installer "optional features" prompt with install-all / skip-all / choose-each — set up any
combination of: KAMP, Axis Twist, TMC Autotune, Skew Correction, the Creality Nebula camera
(persistent image tuning + H.264 stream, as one option), and the Pause/Resume layer-shift fix
(y_park222→220). Config installs via theGuppyScreen/*.cfginclude mechanism; only the Axis-Twist
probe.pypatch and the layer-shiftgcode_macro.cfgedit touch existing files, and both are backed
up first and guarded (skipped if not applicable). - Self-contained Nebula camera persist macros (
nebula_camera.cfg) — re-applies image settings on
every boot so they survive reboots, with or without the Helper Script'sCAM_*macros. - Vendored Creality macros (GPL-3.0, from the Creality Helper Script) as their own installer option:
M600 filament change, Save Z-Offset (native z-offset persistence — no longer delegated to the
Helper Script), useful macros (backup/restore, PID, bed-level, warmup), and Exclude Object
(+enable_object_processingin moonraker.conf). Each.cfginstalls only if its sections don't
already exist (section-conflict guard), so it never causes a duplicate-section crash. - Real, split wiki — User vs Developer sections, plain "reddit-style" guides, including new
Perfect prints — start here and Calibration, explained (recalibrate-vs-reset, hardware-change
matrix) pages. Publishing mechanism documented in Publishing this wiki. - This CHANGELOG.md.
Changed
- Rebrand GuppyKE → OpenKE across the README and wiki (the touch UI is now framed as one part of a
perfect-prints toolkit). Git repo name unchanged, so existing installs/updaters keep working. guppy_cmd.cfgnow ships[guppy_config_helper], so the on-screen TMC Autotune Save works without
a manual edit.- Mod/install wiki pages rewritten: the installer does the setup; manual steps kept as an advanced
section on each page.
Fixed
- Filament-runout Cancel dialog — now shows "Cancelling print…", disables its buttons, and stays up
with feedback until the print actually stops (the runout sensor could otherwise re-fire and re-pop it). - Input shaper — fixed a crash after each axis (a result toast read the wrong JSON key); the console
shaper list now lists shapers in the same order as the graph legend (Klipper'sINPUT_SHAPERS
order) instead of alphabetically; ASCII-only toast text so it renders cleanly in the compact font; and
a much longer calibration watchdog (the KE's numpy analysis is genuinely slow, ~3 min/axis).
Safety
- A fresh timestamped
printer.cfgbackup on every installer run;probe.pybacked up before the
Axis-Twist patch. Re-running the installer does not rewrite saved calibration values. - Fully reversible uninstall —
installer.sh uninstallrestores the Creality display/app stack from
backup and renamesMonitor/display-serverback automatically (guarded), so both install choices
revert cleanly on the next reboot. - Duplicate-section guards: the installer detects an existing
[axis_twist_compensation],
[skew_correction], KAMP, M600, Save-Z-Offset, or Exclude-Object setup and leaves it alone instead of
adding a conflicting copy. The check looks only at actively-loaded config files (printer.cfg+ its
[include]globs, nested) and only at uncommented section headers — so it correctly ignores the
KE's commented-out stock sections (e.g.#[filament_switch_sensor ...]) and the*.bak/printer-*.cfg
backups in the config dir. Verified against a live KE under its BusyBox.
v0.5.5-GuppyKE
Changed
- WiFi power-save toggle renamed "Low Latency" and expanded into a full bundle — it now disables WiFi
power-save, turns off background roam-scans, and stops Bluetooth (the BCM4343 shares one antenna for
WiFi/BT, and the coexistence caused latency spikes).
Added
- TMC Autotune user guide — explains the greyed-out Save button, documents all four tuning goals,
and notes the Sensorless Threshold is hidden on the KE.
Fixed
- WiFi "Low Latency" hint left-aligned and shrunk (montserrat 14→12) so it clears the Back button.
- Broken Skew documentation link; completed the README documentation index.
v0.5.0-GuppyKE
Added
- Skew Correction panel in the Tune tab, plus a printable skew-calibration frame.
- 0.001 mm Z-offset baby-step option.
- First end-user wiki pages + README refresh.
Fixed
- TMC Metrics crash on TMC2208 drivers (no CoolStep/StallGuard) — guarded; the CoolStep +/- adjusters
are now hidden on drivers that don't have them.
Changed
- Dropped the bundled skew-calibration g-code — slice your own square instead.
v0.4.0-GuppyKE
Added
- Guided Axis Twist Compensation calibration wizard in the Tune tab.
- WiFi power-save toggle for lower latency — re-applied on every reconnect / network switch, and a
boot-race fix so it survives a reboot. - Documentation: KAMP + Axis Twist Compensation first-layer guide (wiki + README link).
Fixed
- "Now printing" overlay jitter — steadied and made into a single tap target.
v0.3.0-GuppyKE
Added
- Power Settings (renamed) with a Power-Loss Recovery section.
Fixed
- OTA in-app updater now points at the coreflake1 fork, ignores
nightly, and filters release assets
correctly. - Bed-mesh table + 3D rendering made robust for KAMP adaptive and dense meshes.
Changed
- CI actions bumped to Node 24 majors; dropped the orphaned lv_drivers build-time patch.
v0.2.0-GuppyKE
First GuppyKE-branded release — the big on-screen feature wave.
Added
- Live Z-offset baby-stepping panel (0.005 / 0.01 mm steps, guarded when not homed).
- Firmware Retraction live-tuning panel.
- Console redesigned as a drill-down command browser.
- Macros redesigned — favorites, collapsible rows, button navigation.
- Notifications split into toasts, modals, and a print-done screen; on-screen toasts for Klipper events.
- Fans — friendly names, read-only fans (heater_fan / output-pin fans), correct editable/read-only split.
- Exclude Object — tap-to-exclude bed map during a print.
- Spoolman filament confirmation at print start.
- Print-status overlay reworked — bigger, preview-led, with a "Paused" chip; Homing/Extrude allowed while
paused; the mesh is viewable (not mutable) during a print. - Extruder heats all filament actions to the selected temp, with clearer feedback.
- Mainsail-matched ETA (averages file / filament / slicer estimates).
Changed
- EMA-smoothed resistive ns2009 touch input for smoother scrolling.
- Thread-safe
State::get_data, tighter LVGL cadence, evdev tracking-id press fix. - CI:
lv_driversnow fetched from the coreflake1 fork (no build-time patch).
v0.1.2-ke-fixes
Added
- Print-status: filename label, dynamic ETA, auto-dismiss when done.
- Extruder: non-blocking heat, auto-extrude on reaching target temp, busy spinner.
KUtils::notify_toasttransient feedback and agcode_scriptresponse-callback overload (groundwork
for later guided flows).
Changed
- CI builds only the Ender-3 V3 KE release asset; added a self-hosted cross-toolchain Docker image.
- Busy spinners normalized to 80×80.
- User-focused README rewrite + in-repo wiki.
- Reverted the v0.1.1 "LED on home / Fine Tune in Tune tab" change.
v0.1.1-ke-gui-fixes
Added
- 480×272 small-screen layout + a global font pass for the KE.
- Bed-mesh panel redesign — table by default, 3D fullscreen.
- Panels gated behind print state (LED ↔ Fine Tune swap).
Fixed
- Display sleep on the Ingenic X2000 DSI — disable
fbdev_blankon sleep (the panel was otherwise
unrecoverable) and invalidate the screen on wake (fixes the white screen after sleep). display_rotate=2default for the KE's upside-down screen mount.- Reduced
LV_FONT_DEFAULTto montserrat_12 on small screens.
Changed
- Installer: uninstall mode,
printer.cfgbackup before modify, silent-include fix, and guards for
files the KE doesn't ship.
v0.1.0 - KE Advanced 3D Bed Mesh
Initial release of the KE fork, based on ballaswag/guppyscreen.
Added
- Advanced 3D bed-mesh visualization with interactive controls.
- Chamber temp on the print screen, default extruder temps, and a WiFi "forget network" button.
- Installer / release scripts adapted for the coreflake1 fork; documented the full fork lineage.