CAN bus UPDATE script

[Dirk]

I have been converting my Voron 2.4 from many-cables-to-the-toolhead, into a single can-cable (4 wires) system.

Even though I saw here that many people really did not like the CAN bus on their printers, mainly because it was new and unknown.

The problem of the web is and always has been, that you never hear the 'satisfied' people. Only the very unhappy, the very happy and the sales-people.

I hope this script will make it easier for some to make the step to the 'new'.

I have never been afraid of new things. The problem was finding a way to find the set up I needed. From one came the other and what happened was, that I was able to combine information from a few sites / github pages I visited, and was able to write a simple script that did all the work.

Actually very much like every software / game in the pre-windows 95 era, came with its own 'set-up' disk, with config.bat / setup.bat files. As long as I do not have a Klipper '95, I think this script will do for me.

I tested it, and it takes 3 to 4 minutes to update the mainboard and toolhead PCB. Faster than 5 minutes I heard mentioned before.

 

I will paste the script down here, with all the comments and the instructions. and attach as an attachment also. If there is a better way, let me know.

It is information gathered mainly from Esoterical's guide. You will need information from this guide to set up your own script. 

 

-------------------------------- SCRIPT flashCAN.sh ------------------------------------------------------------------

#!/bin/bash
### without the extensive documentation and work of Esoterical, this would never have been possible. 
### Besides Esoterical, this script builds standing on shoulders of:
### Eddie the engineer. https://www.youtube.com/watch?v=1P4UrJxChL8 Thanks!
### cruiten https://github.com/cruiten/Voron-Related/blob/main/CANbus/Documentation/SB2040_CAN/flash_klipper_script.md Thanks!

### uses # https://docs.kernel.org/kbuild/kconfig.html KCONFIG_CONFIG is used to define an alternative config file...
### to define a separate config file for mainboard (eg Octopus) or for a canbus toolhead PCB. For both cases one for katapult and one for klipper.

### the make menuconfig commands use the Esoterical github provided 'mainboard/common_hardware and toolhead_flashing/common_hardware maps provided image options
### https://canbus.esoterical.online/mainboard_flashing/common_hardware.html
### https://canbus.esoterical.online/toolhead_flashing/common_hardware.html

### HOW TO USE: Follow Esotericals guide, starting at the begin: https://canbus.esoterical.online/Getting_Started.html
### it will lead you through setting up a can network on your Klipper running os. 
### I skipped the part about dedicated can_boards, and continued with the klipper USB 2 CAN bridge provided by my mainboard: https://canbus.esoterical.online/mainboard_flashing
### will go through flashing your mainboard for CAN. go through EVERY step. and DO NOT skip the STOP warnings. This will install katapult. USB2CANbus bridge 
### afterwards it will assist you through flashing your toolhead: https://canbus.esoterical.online/toolhead_flashing
### like with the mainboard, you will install katapult and then the klipper can interface on it.
### when you are finished, you get advise on how to finish it: https://canbus.esoterical.online/Final_Steps.html

## You are happy and you see an update from Klipper in mainsail. You push the update button and your whole system is unaccessable, 
## because your hardware is no more up to date with the latest klipper...
## in that case you can follow the "so you clicked the update button???" : https://canbus.esoterical.online/Updating.html

## because I did not want to go through the same repetitive steps, I made this below script. 
## If I did not think this would be faster than the 5 minute update teamfdm.com @mvdveer needs to update his printers, I would have kept it to myself.

## -------------------------------------------------------- HOW TO USE -----------------------------------------------------------
## save this document and copy to your klipper system into the /klipper directory.
## give it a name (eg. flashCAN.sh)
## ssh into your system. go to your klipper directory and run the command: sudo chmod +x flashCAN.sh
## now you can run the script by typing the following command in ssh
## ~/klipper/flashCAN.sh

## make sure to fill in your OWN values for 
## - usb-katapult_your_mainboard_usb_id
## - yourmainboarduuid
## - yourtoolheaduuid

# these are values for me! 
# yourmainboardUUID=403544310df5
# katapult_your_mainboard_usb_id = usb-katapult_stm32f446xx_200035000851313133353932-if00
# yourtoolheaduuid =21c36fa97c26


## while installing CAN the first time, note your usb-katapult-mainboard-usb-id, mainboard UUID, toolhead UUID. 
## or if you have a functioning CAN network, run ~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0 to see a list of installed CAN devices.
## the UUID for mainboard and toolhead you need to put in your printer.cfg file, so you can retrieve it from there.
## But the USB serial ID you have to obtain after you put the mainboard into katapult boot flash mode (STEP 2 A below).

## after  the command  python3 ~/katapult/scripts/flashtool.py -i can0 -u yourmainboarduuid -r 
## you will need to type: "ls /dev/serial/by-id" and it will give you your USB serial ID.

## once you have run through this script, comment out (put a # in front of the line) the line which has the "make menuconfig" in it.
## and the next time you have a klipper update that breaks your CAN, all you have to do, is to run this script once.


#-------------------------------------FINAL WORDS--------------------------------------------------
# this script is for me and my set up.
# HARDWARE
# Raspberry Pi 4B, 8mb
# Voron 2.4, 350
# Octopus Pro mainboard
# SB2209 (RP2040) Big Tree Tech 2 part Toolhead PCB
# Cartographer 3D Eddy Probe in CAN mode
# with built in accelerometer / resonance tester
# The Octopus functions as a CAN bridge. Cartographer 3D is connected to The SB2209 (RP2040). 
# The CAN bus is terminated at the Cartographer 3D probe.

# SOFTWARE:
# OS: Raspbian GNU/Linux 11 (bullseye)
# Distro: MainsailOS 1.2.1 (bullseye)
# klipper: v0.12.0-114-ga77d0790

# if you are not using this script on my system then anything can happen which I am not responsible for.




echo "STEP 1 - UPDATE KATAPULT FROM GIT if needed"
test -e ~/katapult && (cd ~/katapult && git pull) || (cd ~ && git clone https://github.com/Arksine/katapult) ; cd ~

echo "STEP 2a - FLASH MAINBOARD KATAPULT so we can flash it easily"
cd ~/katapult
make clean KCONFIG_CONFIG=config.mainboardKatapult # cleans old files
make menuconfig KCONFIG_CONFIG=config.mainboardKatapult # this can be commented out for automation AFTER you have filled out correct fields for your card. or leave it in to have some control
make KCONFIG_CONFIG=config.mainboardKatapult # this creates a deploy.bin
python3 ~/katapult/scripts/flashtool.py -i can0 -u yourmainboarduuid -r # puts mainboard in katapult flash mode
python3 ~/katapult/scripts/flashtool.py -f ~/katapult/out/deployer.bin -d /dev/serial/by-id/usb-katapult_your_mainboard_usb_id # flashes katapult to mainboard


echo "STEP 2b - FLASH MAINBOARD so it works as a CAN BRIDGE, over KATAPULT"
cd ~/klipper
make clean KCONFIG_CONFIG=config.mainboardUSB2CANbb # cleans old files
make menuconfig KCONFIG_CONFIG=config.mainboardUSB2CANbb # configuration for klipper-U2CBB. comment this line for automation
make KCONFIG_CONFIG=config.mainboardUSB2CANbb # this creates klipper.bin 
sudo service klipper stop
# mainboard still in katapult forced flash mode. so feel free to flash klipper can bridge on it!
python3 ~/katapult/scripts/flashtool.py -f ~/klipper/out/klipper.bin -d /dev/serial/by-id/usb-katapult_yourmainboardusbid # flashes klipper-U2CBB to MAINBOARD
sudo service klipper start


echo "STEP 3a UPDATE TOOLHEAD KATAPULT so we can flash it easily"
cd ~/katapult
make clean KCONFIG_CONFIG=config.toolheadKatapult # clean old files
make menuconfig KCONFIG_CONFIG=config.toolheadKatapult # comment out for full automation after once filled out!
make KCONFIG_CONFIG=config.toolheadKatapult # build katapult deployer.bin
python3 ~/katapult/scripts/flashtool.py -i can0 -u yourtoolheaduuid -r # put toolhead board into katapult flash mode
python3 ~/katapult/scripts/flashtool.py -i can0 -u yourtoolheaduuid -f ~/katapult/out/deployer.bin # flash the katapult binary


echo "STEP 3b UPDATING TOOLHEAD KLIPPER over KATAPULT"
cd ~/klipper
make clean KCONFIG_CONFIG=config.toolheadKlipper
make menuconfig KCONFIG_CONFIG=config.toolheadKlipper
make KCONFIG_CONFIG=config.toolheadKlipper
sudo service klipper stop
python3 ~/katapult/scripts/flashtool.py -i can0 -u yourtoolheaduuid -f ~/klipper/out/klipper.bin
sudo service klipper start

echo " The Klippper update flash script has finished. Hopefully all is working again :-)"

flashCAN.sh

[mvdveer]

Sure this will help out a lot of members. May even convince @claudermilk to change to canbus  (You know I am not going to stop pestering)

[Dirk]

 After reading so much about problems and troubles here on this forum, on other forums, but also on the voron discord, I expected all kind of problems with "flashing". 

Following that Esotericals guide, I set up my canbus during just an evening. A breeze... The only thing I did not read in the manual, but remembered from here, was to remove all cables out of the Octopus before trying to flash it  (Thanks @mvdveer

Besides the software side, I also made a few pictures about a few more reasons why you should use CAN (or reduce the number of cables).

[ChicagoKeri]

Thank you for this!

Even the poorly-documented and poorly-implemented CAN that Klipper uses works great once you get through the initial setup... until a Klipper update breaks it .  

Even when  running CAN through a UBS connection by U2C,  CAN has been a most reliable part of my system.   The inherent fault-tolerance that serves the Automotive world so well really shines in a 3D printer.

I suspect that if Klipper/BTT/Mellow/etc.. ever gets to where RepRapFirmware/Duet is with their CAN-FD, USB will be done with actual control of the printer.

[zav3nd]

All spanish linux for me right now. But posting so maybe down the line when mines built I remember to come back here.

 

(In all seriousness, I've only bareley looked at klipper and canbus, going to get mine running first and go from there.) And thanks for being one to document before I take the plunge!

Edited February 26, 2024 by zav3nd

[Dirk]

8 hours ago, zav3nd said:

All spanish linux for me

Which is, I think, a good thing

I have seen many manuals, using about 3 different tools, and at least 2 different os'es and referring to website that are not in Spanish, but in Chinese  

As I also wrote above, this script requires you to follow Esoterical's fool proof steps to set up the hardware, simply in your printers linux.

Then when there is an update, you run this script, which is following part-2 of esoterical's site " So you clicked the much feared update button..." 

 

When I saw this the first time, I had to think of the beginning of this post from @Maurici and the avalanche of frustration that came out of many others " My OCD forced me to click the update all button and now all my ptinters are out of comission"

Once you have run this script and set up all four make menuconfig screens once, you can comment those lines that start with make menuconfig out and it will be a fully automated script for updating your mainboard and toolhead PCB. 

 

Edited February 26, 2024 by Dirk
gif not displaying

[Dirk]

11 hours ago, ChicagoKeri said:

Thank you for this!

Even the poorly-documented and poorly-implemented CAN that Klipper uses works great once you get through the initial setup... until a Klipper update breaks it .  

Even when  running CAN through a UBS connection by U2C,  CAN has been a most reliable part of my system.   The inherent fault-tolerance that serves the Automotive world so well really shines in a 3D printer.

I suspect that if Klipper/BTT/Mellow/etc.. ever gets to where RepRapFirmware/Duet is with their CAN-FD, USB will be done with actual control of the printer.

You are welcome. I hope it will help ease newcomers into CAN. Because now I have gone through that rabbit hole, I understand better the things I have read about it.

As I wrote earlier, all you see is either the very negative, or the very positive. The most obvious things like a kilo of cables that are not there anymore, the order it brings with it, the ease of adding additional components, are forgotten.

And your prophecy about USB, time will tell But things that are widely spread, do not tend to get forgotten so easily. Even when they are obsolete.

Edited February 26, 2024 by Dirk

[Squibo]

Asking for a friend, say they were stupid enough to not note down the mainboard uuid and can't seem to find it in the printer.cfg, but has everything else.

How would that friend find that info?

EBB2209/U2C/Octopus v1.1

 

Edited February 26, 2024 by Squibo

[Dirk]

1 hour ago, Squibo said:

the mainboard uuid

It is not a stupid question. I have only heard a few in my whole life, but... It is a difficult question to answer.

1- A simple text search (canbus_uuid) inside printer.cfg should give you the UUID.

mine in printer.cfg looks like this:

[mcu]
# serial: /dev/serial/by-id/usb-Klipper_stm32f446xx_200035000851313133353932-if00 (BEFORE CAN)
canbus_uuid: 403544310df5

 

2- If it does not, it means you are not already using the UUID of your mainboard, so you should be able to find it in the list of UUIDs that are free by typing: 
~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0

BEFORE I wrote these ID's down inside printer.cfg, and thus claimed the ID's,  this command gave me the following output:

 Found canbus_uuid=403544310df5, Application: Klipper - OCTOPUS PRO 1.01
 Found canbus_uuid=a74fbb9bdf70, Application: Klipper - CARTOGRAPHER v3
 Found canbus_uuid=21c36fa97c26, Application: Klipper - SBB2209 RP2040

 

3- If you can not find it, I would recommend to go simply through the steps of Esotericals Getting Started page. It will step by step get you there where you want to be.

 

I see you also have the U2C, if you set it up once during the initial set up, you will not need to use steps 2A and 2B of this script.

 

 

 

[claudermilk]

18 hours ago, mvdveer said:

Sure this will help out a lot of members. May even convince @claudermilk to change to canbus  (You know I am not going to stop pestering)

LOL. Not right now--I only recently moved to the tool head PCB setup. When that harness wears out I'll think about it. By then though the LDO board ought to be well settled too.

[ChicagoKeri]

23 hours ago, Squibo said:

Asking for a friend, say they were stupid enough to not note down the mainboard uuid and can't seem to find it in the printer.cfg, but has everything else.

How would that friend find that info?

EBB2209/U2C/Octopus v1.1

Tell your friend that this involves using ssh to access the pi with the system running in order to search the CANbus for connected devices…

~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0

there’s a couple of reasons this might not work though…  good luck!

 

[Maurici]

On 2/26/2024 at 2:29 AM, zav3nd said:

All spanish linux for me right now

El Español es bastante más comprensible que esa línea de comandos... Especialmente si es tu idioma nativo

On 2/26/2024 at 10:36 AM, Dirk said:

When I saw this the first time, I had to think of the beginning of this post from @Maurici and the avalanche of frustration that came out of many others " My OCD forced me to click the update all button and now all my ptinters are out of comission"

Still trying to convince people to use can?

[zav3nd]

1 hour ago, Maurici said:

El Español es bastante más comprensible que esa línea de comandos... Especialmente si es tu idioma nativo

I barley manage English sometimes...

[Dirk]

56 minutes ago, Maurici said:

Especialmente si es tu idioma nativo

Spanish is not much different than Latin. With that it is the base language of all western european popular languages. So Spanish, French, Italian are not far away from Latin (Roman). Once you know one of them, no need to speak it as native, you understand all of them. English, Dutch, German, all the nordic languages are not much further away. I neve was able to rhyme in Greek into the western european languages.

But... I am not trying to convince anyone. 

I just think something that is new, should not be refused, because you are old, and like what you were used to. Sometimes you need to take a dive

I was afraid of all the stories here on the forum. Very experienced and respectable people that refused to make the step to CAN.

And your post also set me back a few weeks in installing the CAN system I bought  But I did it. 

And I succeeded in one go. Was ready converting the whole thing in an afternoon (old man tempo, checking everything triple). None of the terrible experiences people describe everywhere. 

And now I think, if anyone will ask me if I can do my first Voron again, I would choose for a CAN setup. Much simpler, easier, cleaner, faster, cheaper.

Again, not trying to convince anyone, but I was so prepared for failure, pitfalls that I had aggregated all this information that is freely available on the net. It was just a simple writeup and test before writing it down here.

If it will help just 1 person, I will be very happy

[Dirk]

On 2/26/2024 at 2:03 PM, Squibo said:

the mainboard uuid

Apparently it happens often enough for Esoterical to dedicate a whole page to it over here.

23 hours ago, ChicagoKeri said:

there’s a couple of reasons this might not work though…

It also goes through the couple of other reasons why it won't work.

But shortly said, the reasons are 

1- if you follow manufacturers manuals for different devices, they give different recommendations. For example they advise you to set up can bus with 250.000 in U2C manual and 1.000.000 in SB2209 manual. 

2- People like to connect canHi cable to canLo it seems. 

[ChicagoKeri]

18 hours ago, Maurici said:

El Español es bastante más comprensible que esa línea de comandos... Especialmente si es tu idioma nativo

Still trying to convince people to use can?

¡No Entiendo Español! Nein! Nicht Versteh! Я немного говорю по русский но не очень хорошо…. And I’m not very good at English either!

[claudermilk]

19 hours ago, Dirk said:

Very experienced and respectable people that refused to make the step to CAN.

I hope you're not putting me into that category! Because I am neither! 

[Maurici]

20 hours ago, Dirk said:

I was afraid of all the stories here on the forum. Very experienced and respectable people that refused to make the step to CAN

who is that here?

55 minutes ago, claudermilk said:

I hope you're not putting me into that category! Because I am neither! 

he really meant clueless and shady.

Edited February 28, 2024 by Maurici

[Dirk]

I have been 'lurking around' here for just a few months, and you guys seem to have answers to all common questions. And have ideas on how to deal with certain things.  Reasons for me to find you experienced. Maybe not very... But experienced. 

And from few things you say, how you are not afraid to express yourselves, it sounds as if you are old. I always learnt to respect the elderly.

So.... There you have it, experienced and respected

Edited February 28, 2024 by Dirk

[Maurici]

1 hour ago, Dirk said:

it sounds as if you are old

Hooooo cowboy, slow down!

I've just turned 40. As everybody say, the 40s are the new 30s that a the same time are the ney 20s, so I'm essentially 20, despite my hair, beer belly and night vision don't seem to agree.

[mvdveer]

4 hours ago, Dirk said:

it sounds as if you are old

Like all good things - only gets better with age.  But why did you have to remind me of that. Going to sit in a corner and contemplate life now.... 

Done - Building another printer, that's what you get for calling me old!

[Dirk]

I said experienced and respected. They wanted me to specify exactly.

And thinking of what you have achieved in life... Isn't that bad.

Another printer?

I didn't know you were done with all your er doctors and Ti backers (auto correct persists it is -to hackers-)  on all printers and your 3 sets of color changers?

Where are the pictures? What is it this time?

Is there a market for built Voron printers in Sydney?

[mvdveer]

2 hours ago, Dirk said:

I didn't know you were done with all your er doctors and Ti backers (auto correct persists it is -to hackers-)  on all printers and your 3 sets of color changers

Not even close to completion. But they are all lined up, ready to go.

2 hours ago, Dirk said:

Another printer?

Nah - just joking/kidding - the wife will kill me!

2 hours ago, Dirk said:

Where are the pictures?

Been working in the VZBot intermittently the past couple of weeks - converting to CNC motor mounts, Y-axis and aluminium X-axis, CPAP fan conversion, the list goes on.

No time to post pictures - may update the thread after completion.

 

2 hours ago, Dirk said:

Is there a market for built Voron printers in Sydney?

Wouldn't know - I am in Melbourne but will be doing a workshop for junior doctors in Sydney next week. All the prep has been done (Printed, just one of many, the models for the cricothyroidotomy station as an example) that will be used - see the printers are useful. Now just to deliver the content, then I can get back to relaxation and tinkering.  (If work doesn't get in the way )

[Dirk]

1 hour ago, mvdveer said:

Nah - just joking/kidding - the wife will kill me!

Made me think... I have been working on this one printer since I got it (june 2023), updating, improving, modding and am still not finished. But you again finished another one

And the market in Sydney... You have to forgive me, when I hear Australia, I think Sydney... I was surprised to find out recently there is even a new Arnhem over there...

But that model looks great for a cricothyroidotomy practice. Will never beat practicing on a cow or a pig though. First thing when I saw that model I had to think of was what a great doc once told me: "looking for a needle in haystack is easier than looking for a piece of glass in a leg, any idea why?"

1 hour ago, mvdveer said:

just to deliver the content, then I can get back to relaxation and tinkering

This also looks like 'relaxing' compared to any E.R. 

And who said plastic is useless? I believe even the latest fighter jets, space ships, The Musks Tesla roadster were first printed before it went into production... not?

[claudermilk]

Well, there was that launch from Relativity Space a few months ago. 85% 3D printed. It actually worked! The thing launched and looked to be going well but had some kind of 2nd stage separation failure, so they aborted (i.e., blew it up). But it got farther than they expected, and it launched.

As I recall Joel had a company showing off their 3D printed rocket engine part. I think at Rapid TCT? Anyway I seem to recall them mentioning it's actually being used by NASA.

Ok, so most of that stuff isn't plastic, but it's still using additive manufacturing, which kind of blows my mind.

Enough tangent off the CANbus topic. Back to lurking around being clueless and shady.