Update to newer Klipper

[alegnn]

Hi !
Thanks again for your great work on this, I use it every day with my Ender 6 and I'd love for this project to remain active !
Would you be able to merge this with a more recent version of Klipper ?
Thanks a lot !

[xdadrm]

@ale-chronics

@ale-chronics, you might find the attached bash script helpful. I've been using it for the past two years to keep my Klipper installation updated with the original Klipper while maintaining the Ender 6 patches from Desuuuu.

Just run the script in the directory where your ./klipper/ is located.
(Make sure you have a backup of your Klipper folder first.)

Also, remember that newer versions of Klipper may require updated firmware on the controller:
( cd klipper; make clean; make (might require make menuconfig, to update the .config file )

bash script :

#!/bin/bash
if [ ! -d klipper/.git ]; then
  git clone https://github.com/Klipper3d/klipper.git klipper
else
  echo "Klipper exists .."
fi

pushd klipper 


if ( git branch | grep desuuuu-ender6 -q ); then
  git switch desuuuu-ender6
else
  git branch desuuuu-ender6  
  git checkout desuuuu-ender6
fi

GIT_EDITOR=/bin/true git pull https://github.com/Klipper3d/klipper.git
GIT_EDITOR=/bin/true git pull -q -X ours --no-rebase https://github.com/Desuuuu/klipper.git

popd

[nipunarora8]

@xdadrm Will this work for CR10s pro. I have desuuuu's klipper installed on my board, rpi and the screen. Can you guide me how to update it?
Would be a great help as I am thinking to install eddy probe which is only supported with mainline klipper + I can keep my klipper updated.
Thanks

[zimmertr]

I recently wrote this guide for installing upstream Klipper on an Ender 6. It just requires changing out the touchscreen: https://github.com/zimmertr/Ender-6-Klipper-Guide

[xdadrm]

@xdadrm Will this work for CR10s pro. I have desuuuu's klipper installed on my board, rpi and the screen. Can you guide me how to update it? Would be a great help as I am thinking to install eddy probe which is only supported with mainline klipper + I can keep my klipper updated. Thanks

@nipunarora8 As I do not have a CR10, I'll not say "it works and here's how" ...hope the following still helps :

Klipper Software
All the script above does it transfer desuuuu's patches into upstream klipper and I use that rather regularly to upgrade my installation. So as long you can get your original klipper directory back, there is little you can break by just trying (a recent backup is always a good idea anyway).

Klipper Firmware on the MCU
Now that is a little trickier, if you're already on a 0.12 version (check klippy*logs for "Last MCU build version: v0.12.0"), if
it is lower on your MCU, communication between Klipper and the MCU will probably not work after the first step.
enter the klipper directory, copy .config from your old klipper directory if you started fresh, and try "make clean; make".
If you get errors, run "make menuconfig" to update .config with new options, usually going with the defaults is ok.
Once the firmware compiles, use out/klipper.bin to upgrade your CR10 MCU, via SDCard.
(also here, having your original .bin file available would allow you to downgrade back to where you have been.)

Display
I do not recall having had to upgrade the display after the initial conversion, so that should continue to work as is.

@zimmertr
A nice, well put together guide ! @nipunarora8 appears to not be using a PI Display but the patched original Creality Display.

[chirrupted]

@xdadrm after adding the [t5uid1] section to printer.cfg (using your script), mainsail gives me an MCU Protocol error saying "mcu 'mcu': Unknown command: t5uid1_ping" at the end (and the screen stays on the klipper logo). could you please guide me in the right direction? I'm still new to klipper. once i remove the [t5uid1] section it doesn't give me an error anymore (but the screen still doesn't work).

[xdadrm]

@chirrupted if you had to add the [t5uid1[ section to your config that sounds like you were NOT running desuuuu's klipper on your setup before ?!

**If that is the case, do not continue, revert back to your old klipper installation and look at @zimmertr 's approach. **

If you want to contine (and I don't know if the CR10s pro is the same as the Ender 6 - MCU and Display wise ..) :

The error sounds like your MCU firmware is not up-to-date - you could check with "grep T5 klipper/.config" it should look like this :

CONFIG_T5UID1_SERIAL=y
CONFIG_STM32_T5UID1_SERIAL_USART3=y
CONFIG_STM32_T5UID1_SERIAL_USART3_PB11_PB10=y

if it is not, use make menuconfig to change the settings, make and then reflash the mcu with the new compiled binary.

[chirrupted]

@xdadrm I use an Ender 5 Plus. anyways, I got it to work (just forgot to flash to the printer :P) however I can't click on the Move button and retracting and advancing filament doesn't work. when printing, the screen doesn't change either (stays on homescreen). before using the script everything worked.

[xdadrm]

@chirrupted Hah, you got me there I've got you mixed up with @nipunarora8 :)

Anyway, glad it 'semi-worked' for you - from your description, I can only imagine that these might be incorrect for your machine / MCU,

CONFIG_STM32_T5UID1_SERIAL_USART3=y
CONFIG_STM32_T5UID1_SERIAL_USART3_PB11_PB10=y

[chirrupted]

@xdadrm thanks! though i think I'll be using an android phone instead :P sorry for wasting your time

[nipunarora8]

@xdadrm Thank you for your ideas. CR10s pro has the same screen as the ender 6 (I guess). And if I am not wrong, desuuuu also has Cr10s pro (because it was his config which I took while setting up klipper).
I will implement your ideas on my printer but I am very busy until the weekend. Will keep you updated. Thanks

[nipunarora8]

Hey @xdadrm, I seem to use your script but no success. I put your script next to klipper folder, ran it, two scripts were having conflicts (src/atsamd/serial.c and src/atsamd/Kconfig) so I used the new version. The make and flashing went without errors. For flashing it generated a .elf file which I flashed using make flash FLASH_DEVICE=serial port

Now my klipper version in mainsail says klipper -> v0.0.0-4766-gdgus-reloaded-230526-0-gbaae7f3a-dirty-inferred

and I can't connect to mcu cuz I have an error gcode command SET_PRINT_STATS_INFO already registered
I commented this line in mainsail.cfg too, but still not luck.

Do you have an idea what can I do to make it work?
Thanks

[xdadrm]

@nipunarora8 there should be no conflict, you can try moving your klipper directory to kipper.broken, and run the script again - that will pull mainline klipper and merge desuuuu's patches in and likely resolve the merge conflict as well as the SET_PRINT_STATS_INFO error.

( The script is 'dumb' and rather forcefully simply merges the two repositories together - often good enough but not failsafe )

Then, best copy your original .config (or kipper.broken/.config) to klipper/.config , rebuild and flash the firmware to be sure to have that match the klipper software.

Good luck !

Looking for SET_PRINT_STATS_INFO in the klipper source shows that it is only used in a single file: klippy/extras/print_stats.py

find . -type f -exec grep -l SET_PRINT_STATS_INFO {} +

./docs/Status_Reference.md
./docs/G-Codes.md
./klippy/extras/print_stats.py
./klippy/extras/pycache/print_stats.cpython-310.pyc

[nipunarora8]

@xdadrm It worked, thank you soo much.

The SET_PRINT_STATS_INFO was basically a problem because of mainsail.cfg. I updated mainsail and things went smooth.
The screen is also working fine as of now, but I will still check if it has any problems.

Thank's for helping. :)

[xdadrm]

@nipunarora8 great to hear, thanks for the feedback !

[brumela]

@xdadrm

bash script :

#!/bin/bash
if [ ! -d klipper/.git ]; then
  git clone https://github.com/Klipper3d/klipper.git klipper
else
  echo "Klipper exists .."
fi

pushd klipper 


if ( git branch | grep desuuuu-ender6 -q ); then
  git switch desuuuu-ender6
else
  git branch desuuuu-ender6  
  git checkout desuuuu-ender6
fi

GIT_EDITOR=/bin/true git pull https://github.com/Klipper3d/klipper.git
GIT_EDITOR=/bin/true git pull -q -X ours --no-rebase https://github.com/Desuuuu/klipper.git

popd

I did update to latest with your script, script works ok and also no errors when building... But after flashing new firmware, move (middle) button, and some buttons in setup are not working. Anyone with same problems?

My printer is Cr10sPro, with latest Desuuuu version of klipper screen was working Ok.

[Lukasgust]

Hm.

That gives me the impression it might be that the display gets data from the mcu, but the mcu does possibly not receive anything back from the display ? Checking connectors on mcu and display side as well as UART config (make menuconfig), looks like UART2 is selected and correct). Perhaps build and flash the MCU firmware once again ?

klipper/.config should contain these lines : CONFIG_T5UID1_SERIAL=y CONFIG_AVR_T5UID1_SERIAL_UART2=y CONFIG_T5UID1_SERIAL_PORT=2

klipper.cfg? where should this be located? When going to klipper/config there is a ton of different printer.cfgs

when I turned on advance config I make menuconfig and chose uart2 for t5uid I had an issue with pin conflict for some reason. and the screen was not working at all. but when just having basic and not applying any uart it's in this semistate of working.

[Lukasgust]

this is the makefile if thats what you meant

Klipper build system

Copyright (C) 2016-2020 Kevin O'Connor kevin@koconnor.net

This file may be distributed under the terms of the GNU GPLv3 license.

Output directory

OUT=out/

Kconfig includes

export KCONFIG_CONFIG := $(CURDIR)/.config
-include $(KCONFIG_CONFIG)

Common command definitions

CC=$(CROSS_PREFIX)gcc
AS=$(CROSS_PREFIX)as
LD=$(CROSS_PREFIX)ld
OBJCOPY=$(CROSS_PREFIX)objcopy
OBJDUMP=$(CROSS_PREFIX)objdump
STRIP=$(CROSS_PREFIX)strip
CPP=cpp
PYTHON=python3

Source files

src-y =
dirs-y = src

Default compiler flags

cc-option=$(shell if test -z "$(1) $(2) -S -o /dev/null -xc /dev/null 2>&1"
; then echo "$(2)"; else echo "$(3)"; fi ;)

CFLAGS := -iquote $(OUT) -iquote src -iquote $(OUT)board-generic/
-std=gnu11 -O2 -MD -Wall
-Wold-style-definition $(call cc-option,$(CC),-Wtype-limits,)
-ffunction-sections -fdata-sections -fno-delete-null-pointer-checks
CFLAGS += -flto=auto -fwhole-program -fno-use-linker-plugin -ggdb3

OBJS_klipper.elf = $(patsubst %.c, $(OUT)src/%.o,$(src-y))
OBJS_klipper.elf += $(OUT)compile_time_request.o
CFLAGS_klipper.elf = $(CFLAGS) -Wl,--gc-sections

CPPFLAGS = -I$(OUT) -P -MD -MT $@

Default targets

target-y := $(OUT)klipper.elf

all:

Run with "make V=1" to see the actual compile commands

ifdef V
Q=
else
Q=@
MAKEFLAGS += --no-print-directory
endif

Include board specific makefile

include src/Makefile
-include src/$(patsubst "%",%,$(CONFIG_BOARD_DIRECTORY))/Makefile

################ Main build rules

$(OUT)%.o: %.c $(OUT)autoconf.h
@echo " Compiling $@"
$(Q)$(CC) $(CFLAGS) -c $< -o $@

$(OUT)%.ld: %.lds.S $(OUT)autoconf.h
@echo " Preprocessing $@"
$(Q)$(CPP) -I$(OUT) -P -MD -MT $@ $< -o $@

$(OUT)klipper.elf: $(OBJS_klipper.elf)
@echo " Linking $@"
$(Q)$(CC) $(OBJS_klipper.elf) $(CFLAGS_klipper.elf) -o $@
$(Q)scripts/check-gcc.sh $@ $(OUT)compile_time_request.o

################ Compile time requests

$(OUT)%.o.ctr: $(OUT)%.o
$(Q)$(OBJCOPY) -j '.compile_time_request' -O binary $^ $@

$(OUT)compile_time_request.o: $(patsubst %.c, $(OUT)src/%.o.ctr,$(src-y)) ./scripts/buildcommands.py
@echo " Building $@"
$(Q)cat $(patsubst %.c, $(OUT)src/%.o.ctr,$(src-y)) | tr -s '\0' '\n' > $(OUT)compile_time_request.txt
$(Q)$(PYTHON) ./scripts/buildcommands.py -d $(OUT)klipper.dict -t "$(CC);$(AS);$(LD);$(OBJCOPY);$(OBJDUMP);$(STRIP)" $(OUT)compile_time_request.txt $(OUT)compile_time_request.c
$(Q)$(CC) $(CFLAGS) -c $(OUT)compile_time_request.c -o $@

################ Auto generation of "board/" include file link

create-board-link:
@echo " Creating symbolic link $(OUT)board"
$(Q)mkdir -p $(addprefix $(OUT), $(dirs-y))
$(Q)rm -f $(OUT).d $(patsubst %,$(OUT)%/.d,$(dirs-y))
$(Q)rm -f $(OUT)board
$(Q)ln -sf $(CURDIR)/src/$(CONFIG_BOARD_DIRECTORY) $(OUT)board
$(Q)mkdir -p $(OUT)board-generic
$(Q)rm -f $(OUT)board-generic/board
$(Q)ln -sf $(CURDIR)/src/generic $(OUT)board-generic/board

Hack to rebuild OUT directory and reload make dependencies on Kconfig change

$(OUT)board-link: $(KCONFIG_CONFIG)
$(Q)mkdir -p $(OUT)
$(Q)echo "# Makefile board-link rule" > $@
$(Q)$(MAKE) create-board-link
include $(OUT)board-link

################ Kconfig rules

$(OUT)autoconf.h: $(KCONFIG_CONFIG)
@echo " Building $@"
$(Q)mkdir -p $(OUT)
$(Q) KCONFIG_AUTOHEADER=$@ $(PYTHON) lib/kconfiglib/genconfig.py src/Kconfig

$(KCONFIG_CONFIG) olddefconfig: src/Kconfig
$(Q)$(PYTHON) lib/kconfiglib/olddefconfig.py src/Kconfig

menuconfig:
$(Q)$(PYTHON) lib/kconfiglib/menuconfig.py src/Kconfig

################ Generic rules

Make definitions

.PHONY : all clean distclean olddefconfig menuconfig create-board-link FORCE
.DELETE_ON_ERROR:

all: $(target-y)

clean:
$(Q)rm -rf $(OUT)

distclean: clean
$(Q)rm -f .config .config.old

-include $(OUT).d $(patsubst %,$(OUT)%/.d,$(dirs-y))

[Lukasgust]

FINALLY! i flashed the screen for the 4th time and now its working!

[xdadrm]

FINALLY! i flashed the screen for the 4th time and now its working!

Congrats ! - it's the .config file in the klipper directory that I meant, that is being created when you run make menuconfig.
You may want to keep that one around for a later upgrade.

Great to hear that you've got things running :)

[Lukasgust]

Dude, I've been so frustrated that I've reimaged Raspberry Pi OS twice and flashed my printer's firmware three times. I probably spent 30hours to get things working xD. Although, thanks for the help.

[ramonimbao]

Tried out xdadrm's fork on my Ender 5 Plus and encountered this error when pressing the Move or Leveling buttons on the screen:

Error evaluating 't5uid1_routine __move:script': AttributeError: 'PrinterProbe' object has no attribute 'multi'
Traceback (most recent call last):
  File "/home/pi/klipper/klippy/extras/gcode_macro.py", line 70, in render
    return str(self.template.render(context))
  File "/home/pi/klippy-env/lib/python3.9/site-packages/jinja2/environment.py", line 1090, in render
    self.environment.handle_exception()
  File "/home/pi/klippy-env/lib/python3.9/site-packages/jinja2/environment.py", line 832, in handle_exception
    reraise(*rewrite_traceback_stack(source=source))
  File "/home/pi/klippy-env/lib/python3.9/site-packages/jinja2/_compat.py", line 28, in reraise
    raise value.with_traceback(tb)
  File "<template>", line 2, in top-level template code
  File "/home/pi/klipper/klippy/extras/t5uid1/t5uid1.py", line 866, in is_busy
    return (self.probe is not None and self.probe.multi != "OFF")
AttributeError: 'PrinterProbe' object has no attribute 'multi'

Was able to fix it by replacing line 866 of t5uid1.py:

return (self.probe is not None and self.probe.multi != "OFF")

with

multi_state = getattr(self.probe, "multi", "OFF")
return (self.probe is not None and multi_state != "OFF")

and got it to work.

[xdadrm]

f t5uid1.py:

return (self.probe is not None and self.probe.multi != "OFF")
with

multi_state = getattr(self.probe, "multi", "OFF")
return (self.probe is not None and multi_state != "OFF")

thanks @ramonimbao - this is probably the right way to address this, mind giving that a go and report back ?

    if self.probe is None:
        return False
    probe_owner = getattr(self.probe, "mcu_probe", self.probe)
    multi_state = getattr(probe_owner, "multi", "OFF")
    return multi_state != "OFF"

[ramonimbao]

   if self.probe is None:
       return False
   probe_owner = getattr(self.probe, "mcu_probe", self.probe)
   multi_state = getattr(probe_owner, "multi", "OFF")
   return multi_state != "OFF"

@xdadrm Thank you! Still works for me.

[xdadrm]

   if self.probe is None:
       return False
   probe_owner = getattr(self.probe, "mcu_probe", self.probe)
   multi_state = getattr(probe_owner, "multi", "OFF")
   return multi_state != "OFF"

@xdadrm Thank you! Still works for me.

Thanks for reporting back ! It's commited in xdadrm@9b88e68

[Desterly]

Tried out xdadrm's fork on my Ender 5 Plus and encountered this error when pressing the Move or Leveling buttons on the screen:

Are you by chance not using a BLTouch on that? The "multi" should exist. I can confirm tonight but on my Ender 5 Plus, I'm not getting this error which makes me wonder.

[ramonimbao]

Yes, I'm using Klicky PCB.

[Desterly]

how is that configured in your klipper config file? I'm wondering what probe type klipper is trying to utilize as the fix above may not actually be detecting the busy state if it's using a different probe configuration

[ramonimbao]

It's configured with probe: https://www.klipper3d.org/Config_Reference.html#probe

[xdadrm]

Tried out xdadrm's fork on my Ender 5 Plus and encountered this error when pressing the Move or Leveling buttons on the screen:

Are you by chance not using a BLTouch on that? The "multi" should exist. I can confirm tonight but on my Ender 5 Plus, I'm not getting this error which makes me wonder.

@Desterly - in THEORY the changes should work, please do let me know if this breaks things for you !

[Desterly]

It's configured with probe: https://www.klipper3d.org/Config_Reference.html#probe

Ah that explains it. "probe" doesn't have a multi element. it does have a multi_probe_pending which True/False which might be what you want to see if it's actually pending/busy.

@Desterly - in THEORY the changes should work, please do let me know if this breaks things for you !

Oh it work I'm sure.. I was more confused as to why it was failing when the element did exist, but it's not universal on all probe types.. I'll have to dig into it and see if there is a means to actually validate the busy status for different probe types. "probe" has multi_probe_pending instead of "multi", but not sure if it does exactly the same thing and not sure if bltouch has it too.