Skip to content

v1.0.0-OpenKE

Choose a tag to compare

@github-actions github-actions released this 16 Jun 18:33
· 14 commits to main since this release

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 +
    idempotent probe.py patcher), and TMC Autotune (evgarthub K1 fork). Each carries its upstream
    LICENSE/NOTICE; see docs/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_park 222→220). Config installs via the GuppyScreen/*.cfg include mechanism; only the Axis-Twist
    probe.py patch and the layer-shift gcode_macro.cfg edit 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's CAM_* 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_processing in moonraker.conf). Each .cfg installs 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.cfg now 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's INPUT_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.cfg backup on every installer run; probe.py backed up before the
    Axis-Twist patch. Re-running the installer does not rewrite saved calibration values.
  • Fully reversible uninstallinstaller.sh uninstall restores the Creality display/app stack from
    backup and renames Monitor/display-server back 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.