Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

It would be great to add some clarity on how the Katapult work, what is the meaning of "double reset" #28

Open
SergeDubovsky opened this issue Dec 1, 2023 · 2 comments

Comments

@SergeDubovsky
Copy link

I was updating the Klipper and I got confused with the script output. It would be beneficial to describe that python3 ~/katapult/scripts/flashtool.py -i can0 -q won't find anything if the UUID is claimed by the running Klipper. Also, it needs either a "double reset" or a restart with stopped Klipper, to appear in the flashtool.py output

@Esoterical
Copy link
Owner

If following the guide step by step there shouldn't really be a time where you would ever need to double-press the reset button to force katapult mode. All the steps to install katapult (from DFU) will do a full ROM erase and therefore the board will just always stay in katapult mode until you flash klipper to it.
When updating (assuming the printer is already working fine) you also don't need to ever double-click reset cause you can force the board into katapult mode by running the -r katapult command as outlined in the UPDATING sections.

I've written it this way because some boards (the mellow fly SB2040 for example, though there are others) just don't have reset buttons at all so I ideally didn't want to reference it as a method. If all the steps are followed as written there should be no need to ever double-click-reset.

Same thing for the -q. The guide never asks you to run a -q query after you have added the UUID to your printer.cfg. It's only when people jump ahead and add it before completing all the steps when it becomes an issue. I do mention it in the troubleshooting section "no_uuid" https://github.com/Esoterical/voron_canbus/blob/main/troubleshooting/no_uuid.md .

As much as I'd love to cover every nuance and function of klipper/katapult in the main guide it just wasn't the goal of this particular guide. At least not in the main Installing sections. The troubleshooting stuff goes into the weeds a bit more.

Apart from that, is there anything specific you think should be added? and if so, where it would logically fit?

@SergeDubovsky
Copy link
Author

The guide is great. But it misses some context, needed to understand how this whole thing works. Why -r is needed and what happen if you don't have the deployer application.

Let me (and my buddy ChatGPT) try to add a pull request with the addition, I had in mind.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants