Connect to Klipper

Note

• This tutorial is for flashing the KLIPPER firmware to the Fly-Buffer-Plus buffer
• After flashing, it means that the pressure firmware pin is overwritten
• The previous functions need to be re-implemented unless you write macros or re-flash the previous firmware
• Any configuration and macro usage need to be written by yourself

Flashing BL

Entering Flash Mode

• There are two ways to enter flash mode
• First method: With the mainboard completely powered off, press the BOOT button and then connect one end of a data transfer cable to the mainboard and the other end to your device
• Second method: After connecting one end of a data transfer cable to the mainboard and the other end to your device, press the BOOT key and then press the RST key, then release the RST key and finally release the BOOT key
  

Flashing Firmware

Windows Flash Tutorial

• The BL firmware of the buffer
  • Click the download link below
• Loading...

Notes

• USB3.0 may not be able to burn, please try to use the USB2.0 of the computer for burning
• If there is no USB2.0 interface, please use an extension dock
• If it still cannot be burned, please use the host software for burning

1. Burning tool Download address
2. Need to download SetupSTM32CubeProgrammer and STM32 DFU driver
3. Copy the compiled firmware (klipper.bin) or the pre-compiled Katapult firmware to any directory on the computer
4. Use a Type-C data cable to connect the mainboard to the computer, and make sure it has entered the dfu burning mode
5. In STM32CubeProgrammer, select USB mode, refresh, and connect
   
6. If no error pop-up appears, the connection is successful.
   Warning

   If the content shown in the figure below appears, it is a computer or software problem. Please use the host software for burning:Host software burning tutorial

   
7. Click the left download icon and select the ones below
   
8. Click the Browse indicated by the arrow, then select the firmware you want to burn
   
9. Select Start address and input 0x08000000
   
10. Click Start automatic mode at the bottom to start burning the firmware
    
11. If the following prompt appears, it means the firmware has been burned successfully
    

Host Computer Flash Tutorial

1. Install the burning tool

• No need to install the burning tool for the FLY upper computer
• If you need to install, please note: The upper computer needs to be connected to the internet to install normally
• If already installed, no need to install

sudo apt update
sudo apt install dfu-util -y

2. Execute the following command to check if the connection is successful.

lsusb

• If there is no DFU device, please try to re-enter burning mode
• Due to system version issues, other names may be displayed. If 0483:df11 is shown, it indicates that the burning mode has been entered

3. Pull the pre-compiled firmware

• These are all pre-compiled firmwares
• Please note: The upper computer needs to be connected to the internet to install
• The upper computer needs to execute the command below to download the firmware package (if unable to get the file due to network issues on the upper computer, please contact the administrator in the after-sales group)

cd && git clone https://github.com/FengHua741/FLY_Katapult.git

• If the firmware package has already been downloaded, it is recommended to update the firmware package before proceeding with the remaining operations

cd ~/FLY_Katapult && git pull

4. Flashing Firmware

tip

Only one of the firmwares needs to be flashed

• Below are the firmware flashing commands

  sudo dfu-util -a 0 -d 0483:df11 --dfuse-address 0x08000000 -D ~/FLY_Katapult/BL/buffer/FLY_BUFFER

5. If the content shown in the arrow in the following picture appears File downloaded successfully, the flashing is successful

   

tip

After flashing, the mainboard needs to be completely powered off once.

USB Firmware Compilation

Start Compiling

• A host machine with the installed klipper service is required Connect via SSH over the network
• Make sure the device is connected to the host machine
• Note: Please use a regular host machine, such as a Raspberry Pi FLY board, etc. If it's a modified host machine (e.g., WiFi stick, Redmi, etc.), due to too many issues, we cannot provide technical support for these machines

warning

• To switch from the ROOT user to a regular user, you can enter the command below
• Do not use the ROOT user
• For the fly user, you can directly enter: su fly. For non-fly users, please replace <your host machine username> with your host machine's username!

su <your host machine username>

::: 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. 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 then select STMicroelectronics STM32 and press Enter

  

• Enter the menu Processor model, select STM32F072 and press Enter

  

• Select Bootloader offset, choose: 8KiB bootloader

  

• Communication interface, select: USB (on PA11/PA12) and press Enter

  

• Please verify against the following image to ensure it matches before proceeding

  

• Press Q key, and Save configuration appears, then press Y key
  
• Now the configuration should have been saved and you should have returned to the command line interface
• Enter the following command to start compiling, 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

• Below is the record of the firmware compilation operation process

Asciinema cast

Entering Flash Mode

Warning

• Double-click the RST button to enter flash mode

Confirm Whether Enter Flash 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.

Flashing Firmware

tip

• When installing the programming plugin, you need to be connected to the internet. Please ensure that your host computer is already properly connected to the Internet.
• If it has been installed, there is no need to install it again.

Start Programming

Warning

• For non-fly host computers, please make sure to execute the following code to install the dependency package for firmware programming! Otherwise, the firmware cannot be programmed!

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

• Use this command to install in China

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

• Use the following instruction to search for your device ID, and the ID shown in the figure below should appear (note: the ID shown in the figure is for reference only, and each motherboard has a different ID):

  ls /dev/serial/by-id/*

  

• To program the firmware, use the following code, and make sure the firmware has been compiled successfully. Please replace <your motherboard ID> with the ID queried in the previous step.

  ~/klippy-env/bin/python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<your motherboard ID>

For the fast system, use this command to program, please replace <your motherboard ID> with the ID queried in the previous step.

python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<your motherboard ID>

• Below is a reference:

  

• After programming is complete, refer to the following:

  

Firmware Update

USB Firmware Update

• Use the following instruction to search for your motherboard ID, and the ID shown in the figure below should appear (note: the ID shown in the figure is for reference only, and each motherboard has a different ID).

  ls /dev/serial/by-id/*

Note

In the figure below, /dev/serial/by-id/usb-katapult_rp2040_E662549553642032-if00 is the motherboard's ID.

• To update the USB firmware, after compiling the latest firmware, enter the following command to update, please replace <your motherboard ID> with the ID queried in the previous step.

  cd ~/klipper/ && make flash FLASH_DEVICE=<your motherboard ID>

  

Bridge CAN Firmware Update

• To update the USB bridge CAN firmware, you need to enter the Katapult after compiling the latest firmware. Enter the following command (the ID in the figure below is for reference only, please use the ID in your configuration file).

Note

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

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

For the fast system, use this command to burn, please replace <your motherboard ID> with the ID queried in the previous step.

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

Note

• In the figure below, f95cee90e1f9 is the motherboard's CANBUS UUID.

• After resetting into Katapult, use the following command to search for your motherboard ID, and the ID shown in the figure below should appear (note: the ID shown in the figure is for reference only, and each motherboard has a different ID).

  ls /dev/serial/by-id/*

Note

In the figure below, /dev/serial/by-id/usb-Klipper_stm32f072xb_43002C000951324757373520-if00 is the motherboard's ID.

• Make sure to execute the programming after the new firmware is compiled successfully. Please replace <your motherboard ID> with the ID queried in the previous step.

  cd ~/klipper/ && make flash FLASH_DEVICE=<your motherboard ID>

  

Solution for Incorrect Firmware Burning

• Power off the motherboard, power on again, and quickly double-click the reset button to re-enter programming mode.
• Or use the window/host machine to re-burn the katapult firmware burn katapult firmware

Search for USB ID

1. Open the browser and enter the IP address of the host computer in the address bar, for example, if the IP address of my host computer is 192.168.101.179, simply enter it and press Enter.

2. Open the WEB interface of the host computer, find in the configuration options on the left sidebar:

For fluidd: {…}, click to enter, you can find printer.cfg

For mainsail: Machine, click to enter, you can find printer.cfg

3. Click into printer.cfg, then click DEVICES on the top right

4. Click SERIAL, then refresh

Refresh for fluidd

Refresh for mainsail

5. Copy the ID, click the arrow to copy

For fluidd, check whether ttyAMC exists and ensure Path by ID exists, this is the USBID

For mainsail, check whether ttyAMC exists and ensure Path by ID exists, this is the USBID

Fill in USB ID

1. Close DEVICES and fill in the ID

Note

• Please modify the configuration file as follows:

[mcu] 
serial: /tmp/klipper_host_mcu

to

[mcu host] 
serial: /tmp/klipper_host_mcu

• Add:

[mcu]
serial: <replace with the ID you just queried>

Find [MCU] in fluidd

Find [MCU] in mainsail

2. Fill in the ID in the configuration

tip

• After filling in the ID, click SAVE & RESTART on the top right

3. If Klipper prompts ADC out of range, this is a normal phenomenon. Connect the heated bed and thermistor to the motherboard, configure the thermistor pins for the nozzle and heated bed, then save and restart.

dangerous

Note: All IDs mentioned in the document are examples. Each motherboard has a different ID, please fill in the actual obtained ID.

---