Klipper LCD Menu

SEE CHANGELOG FOR RECENT BREAKING CHANGES

A custom menu system for LCD displays on klipper such as a 12864LCD screen. Intended to extend the functionality beyond the default klipper LCD menu provides, while being printer and configuration agnostic. Layout is organized into what I would consider a more logical workflow.

To utilize the network-status menus you will need to first install the plugin. If this plugin isn't installed the menu will be hidden. https://github.com/JeremyRuhland/klipper_network_status

Install

cd ~
git clone https://github.com/DasBurninator/klipper_lcd_menu
ln -s ~/klipper_lcd_menu ~/printer_data/config/lcd_menu
cp ~/klipper_lcd_menu/lcd_menu_settings.cfg ~/printer_data/config/

Add the following to printer.cfg:

[include lcd_menu_settings.cfg]

Make any edits needed to the lcd_menu_settings.cfg

Updates

Manual Update

cd ~/klipper_lcd_menu
git pull

Moonraker Update Manager

Updates require that Moonraker is run in debug mode for unofficial repos. See the Moonraker documentation below: Enabling debug mode in Moonraker

Once Moonraker is running in debug mode the follow can be added to the moonraker.conf file

[update_manager client klipper_lcd_menu]
type: git_repo
channel: dev
primary_branch: main
path: ~/klipper_lcd_menu
origin: https://github.com/DasBurninator/klipper_lcd_menu
managed_services: klipper

Menu Layout

• Prep (Disabled When Printing)
  • Prep ABS
  • Prep PLA
  • Z Tilt > Park (If Z-TILT is enabled)
  • QGL > Park (If QUAD_GANTRY_LEVELING is enabled)
  • Park (Parks toolhead in center of the bed)
  • Park Rear (Parks toolhead center rear of the bed)
• Print (Enabled During Printing)
  • Resume printing (Enabled when Paused)
  • Pause printing (Enabled During Printing)
  • Cancel printing (Enabled During Printing)
• Tune (Enabled During Printing)
  • Offset Z:00.00
  • Flow: 000%
  • Speed: 000%
  • Fan speed: 000%
  • Retraction (firmware_retraction must be enabled)
  • Pressure Advance
  • Machine Limits
• Control (Disabled When Printing)
  • Homing
    • Home All
    • Home Z
    • Home X/Y
    • Z Tilt
    • Quad Gantry Lvl
    • Bed Mesh
  • Move
    • Move 10mm
      • Move X:000.0
      • Move Y:000.0
      • Move Z:000.0
      • Move E:+000.0
    • Move 1mm
      • Move X:000.0
      • Move Y:000.0
      • Move Z:000.0
      • Move E:+000.0
    • Move 0.1mm
      • Move X:000.0
      • Move Y:000.0
      • Move Z:000.0
      • Move E:+000.0
  • Steppers off
  • Fan: OFF
  • Fan speed: 000%
  • KlickyProbe
    • Attach Probe
    • Dock Probe
• Temperature
  • Ex0:000 (0000)
  • Ex1:000 (0000)
  • Bed:000 (0000)
  • Preheat PLA
    • Preheat all
    • Preheat hotend
    • Preheat hotbed
  • Preheat ABS
    • Preheat all
    • Preheat hotend
    • Preheat hotbed
  • Cooldown
    • Cooldown all
    • Cooldown hotend
    • Cooldown hotbed
• Filament
  • Ex0:000 (0000)
  • Load Filament
  • Unload Filament
  • Purge Filament
  • Feed: 000.0
• Calibration (Disabled When Printing)
  • Probe Calibration
    • Probe
    • Probe Accuracy
    • Probe Calibrate
  • Delta Calibration
  • PID Tune
    • PID Tune ABS (tunes both bed and extruder for ABS temps)
    • PID Tune PLA (tunes both bed and extruder for PLA temps)
    • Ex0 PID
    • Bed PID
    • Save Config
• System
  • Save config
  • Restart
    • Restart host
    • Restart FW
  • Network (Requires network-status plugin from https://github.com/JeremyRuhland/klipper_network_status)
    • mDNS
    • Eth IP
    • Wifi SSID
    • Wifi IP

Changelog

Jan 29th 2024

Major rework. Will require reinstall!!

If you have previously defined display_group: __voron_display under the [display] section, you will need to remove this, as it is now defined automatically to allow for less config needed on the users' side.

Only one file now needed to be included in the printer.cfg.

• Steamlined user install/config experience.
• Added variable system to enable and disable certain settings. Borrowed from https://github.com/jschuh/klipper-macros
• SD Card and Octoprint menu options can now be enabled throug the variables mentioned above. They are disabeld by default
• lcd_tweaks from Voron docs modified to accomodate variables for serial number input
• lcd_tweaks now enabled by default without users needing to add additional configuration to the [display] section of thier config
• All above changes will allow for less disruptive upgrades in the future as well.

Dec 12th 2023

• Added lcd_tweaks.cfg
• Updated Install and update instructions in README.md

Feb 9th 2023

• Initial set of commits and debugging
• Added network_status plugin menu options (conditional that plugin is enabled)
• firmware_retraction and pressure_advance tuning menus now conditional of those options being enabled.
• Completely reorganized the Control Menu
  • Added Homing menu and moved Home/Z-tilt/QGL/etc into this menu
  • Added Move menu and moved Move 0.1mm/1mm/10mm menus under this
  • Disabled Lighting Controls
• Removed Setup menu
• Added Calibration Menu
  • Delta Calibration under its own menu
  • Probe Calibration menu added with multiple probing options
  • Added Bedmesh menu item
• Added Lights Menu
  • Stealthburner light menu with basic control over nozzle LEDs and Logo light
  • Moved caselight from Control menu
  • Made light macros conditional to the macros existing

Feb 9th 2023

• Fixed Pressure Advance menu not displaying
• Fixed Network menu not displaying
• Fixed KlickyProbe menu options and created a conditional to QGL or Z-Tilt prior to bedmesh if printer is equiped.

TODO

• Modify Filament Load/Unload/Purge to not rely on a set of macros
• Add BLtouch menu item under Control > BLTouch
• Finish Calibration Menu
• Add in klipper connection status in System menu
• Add Z offset calibration menu
• Impliment emergency stop
• Create conditional parking menu under the Prep Menu that works for Delta printers as well.
• Make Prep ABS and Prep PLA options not reliant on macros