USB firmware compilation

Start compiling

• A host computer with the klipper service installed is required Connect via SSH over the network
• And the device is connected to the host computer
• Note: Please use a regular host computer, such as Raspberry Pi FLY. If it is a modified host computer (such as a WiFi stick, Redmi, etc.), due to too many issues, we cannot provide technical support

FlyOS-Armbian system and general system notes

warning

• Notes on FlyOS-Armbian system and general system
  • Ordinary host computer systems such as Raspberry Pi, FLY are viewed in this category
  • Do not use the ROOT user for any operations on these host computers
  • Please use a normal user for operations
  • To switch users, for FlyOS-Armbian system use the su fly command to switch to a normal user
  • For other systems, use the su <your host computer username> command to switch to a normal user

  su <your host computer username>

FlyOS-FAST system notes

warning

• Notes on FlyOS-FAST system
  • The default username for FAST system is root, password is mellow
  • Compiling firmware can only be done using the root user
  • And FAST system only has ROOT user, you don't need to switch users!!!

::: tip

• Please ensure that the host machine can connect to the network normally.
• Before compiling the firmware, use SSH to log in to the host machine via the network.
• Do not use a serial port tool to log in to the host machine.

:::

Klipper Firmware Compilation and Configuration Page Operation Instructions

::: tip

Please make sure that the keyboard input method is in half-width mode, i.e., English mode.

:::

1. The key ↑ (up arrow) and ↓ (down arrow) on the keyboard are used to move the cursor up and down to select menu items.
2. The confirm key Enter or spacebar Space is used to check the menu or enter a sub-menu.
3. The exit key ESC is used to return to the previous menu.
4. The Q key is used to exit the Klipper firmware configuration page.
5. When exiting the Klipper firmware configuration page and there is a prompt, press the Y key to save the configuration file.

::: warning

If there are fewer options in the configuration page, please first check [ ] Enable extra low-level configuration options to display some hidden options.

:::

Below is the introduction on how to compile the firmware:

• After connecting to SSH, enter the following command and press Enter:

  cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig

• Where rm -rf ~/klipper/.config && rm -rf ~/klipper/out is to delete previous compilation data and firmware, and make menuconfig is to compile the firmware. After execution, the following interface should appear:

  

• Select Enable extra low-level configuration options and press Enter.

  

• Enter the menu Micro-controller Architecture and then select Raspberry Pi RP2040/RP235x and press Enter.

  

• Select Bootloader offset, and choose: 16KiB bootloader.

  

• For Communication interface, choose: USBSERIAL.

  

• Press the Q key, and Save configuration appears, then press Y key
  
• Now the configuration should be saved and exit to the command line interface
• Enter the following command to start the compilation, which takes some time

make -j4

• If the following content is output, the compilation is successful

  Linking out/klipper.elf
  Creating hex file out/klipper.bin

Confirm whether to enter the flashing mode

• Please ensure that the host machine can connect to the network normally and ensure that the data cable connecting the lower-level machine to the host machine has data transmission function.
• After SSH connecting to the host machine, input lsusb and press Enter. If the information circled in the following picture appears, you can proceed to the next step.
  • If there is no feedback at all, this is a system problem of the host machine, and we are unable to help. You need to replace with a confirmed normal system or replace the host machine.
  • If the prompt says there is no lsusb command, you can execute the following command to install it:

    sudo apt-get install usbutils

    
• 1d50:6177 belongs to the device you will use this time.
  • Some host machines may not fully display or fail to display due to system problems.
  • If the lsusb command can display the device but does not show 1d50:6177, please try replacing the data cable and connecting the mainboard to another USB port on the host machine.
• If you have executed the above steps before and successfully burned the Klipper firmware, and the mainboard is running normally, but you just want to update the Klipper firmware, please directly check the Firmware Update section in the right menu bar of this page.

Notice

You must query the 1d50:6177 device before proceeding to the next step.

Flash the firmware

tip

• Internet connection is required when installing the flashing plugin. Please ensure your host machine is properly connected to the internet.
• If already installed, there is no need to install again.

Start Flashing

Warning

• For non-fly host machines, please execute the code below to install the required dependency packages for firmware flashing! Otherwise, the firmware cannot be flashed!

  Default Repository

  cd && git clone https://github.com/Arksine/katapult.git

  Domestic Repository

  cd && git clone https://gitee.com/MrCakeFuck/katapult.git

  

• Use the command below to search for your device ID. The ID shown in the figure below should appear (Note: The ID shown in the figure is for reference only; each motherboard has a unique ID).

  ls /dev/serial/by-id/*

  

• Use the code below to flash the firmware. Please ensure the firmware has already been compiled, and replace <你的主板ID> with the ID obtained in the previous step.

Fly-Armbian and Standard Host Flashing Method

~/klippy-env/bin/python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<你的主板ID>

Fly-FAST Flashing Method

python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<你的主板ID>

• Reference image is shown below:

  

• Reference after flashing is completed:

  

Firmware Update

USB Firmware Update

• Use the following command to search for your motherboard ID. The ID shown in the figure below should appear (Note: The ID shown in the figure is for reference only; each motherboard has a unique ID).

  ls /dev/serial/by-id/*

Note

The ID /dev/serial/by-id/usb-katapult_rp2040_E662549553642032-if00 in the figure below is the motherboard ID.

• After compiling the latest firmware, use the command below to update the USB firmware. Please replace <你的主板ID> with the ID obtained in the previous step.

  cd ~/klipper/ && make flash FLASH_DEVICE=<你的主板ID>

  

Bridged CAN Firmware Update

• To update the bridged CAN firmware over USB, after compiling the latest firmware, run the command below to reset into Katapult. (As shown in the figure below, the ID is for reference only; please use the ID from your configuration file.)

Note

• <CANBUS UUID> is the CANBUS UUID of the motherboard specified in your printer.cfg configuration file.

Fly-Armbian and Standard Host Reset to Flash Method

• Replace <你的主板ID> with the ID obtained in the previous step.

  ~/klippy-env/bin/python3 ~/katapult/scripts/flashtool.py -i can0 -r -u <CANBUS UUID>

Fly-FAST Reset to Flash Method

• Replace <你的主板ID> with the ID obtained in the previous step.

  python3 ~/katapult/scripts/flashtool.py -i can0 -r -u <CANBUS UUID>

Note

• The f95cee90e1f9 in the figure below is the CANBUS UUID of the motherboard.

• After resetting into Katapult, use the command below to search for your motherboard ID. The ID shown in the figure below should appear (Note: The ID shown in the figure is for reference only; each motherboard has a unique ID).

  ls /dev/serial/by-id/*

Note

The ID /dev/serial/by-id/usb-Klipper_stm32f072xb_43002C000951324757373520-if00 in the figure below is the motherboard ID.

• Ensure the new firmware has been compiled before executing the flashing. Replace <你的主板ID> with the ID obtained in the previous step.

  cd ~/klipper/ && make flash FLASH_DEVICE=<你的主板ID>

  

Recovery Method for Incorrect Firmware

• Power off the motherboard, then power it on again and double-press the reset button quickly to re-enter flashing mode.
• Alternatively, use Windows/host machine to re-flash the Katapult firmware Flash Katapult Firmware