Skip to main content

USB Firmware Compilation

tip
  • The USB accelerometer has the Katapult firmware for USB connection pre-flashed at the factory.
  • If it is not flashed, you can flash it yourself.
  • Katapult Firmware Burning

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
  • 请确保上位机可以正常联网
  • 固件编译前需要使用SSH通过网络登录上位机
  • 请不要使用串口工具登录上位机

Klipper固件编译和配置页面操作说明​

tip

请确保键盘输入法为半角模式，即英文模式

  1. 键盘上键↑，下键↓，用于上下移动光标来选中菜单项
  2. 确认键Enter 或 空格键Space，用于勾选菜单或进入子菜单
  3. 退出键ESC，用于返回上一级菜单
  4. Q键，用于退出Klipper固件配置页面
  5. Y键，在退出Klipper固件配置页面时，如果有提示，则点击Y键保存配置文件
warning

如果配置页面选项比较少，请先勾选[ ] Enable extra low-level configuration options，用于显示部分隐藏选项

Below is an 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

  • Among them, 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, then select Raspberry Pi RP2040 and press Enter

  • Select Bootloader offset, choose: 16KiB bootloader

  • Communication interface, choose: USBSERIAL

  • Select GPIO pins to set at micro-controller startup, input: gpio24
  • Press Q, and when Save configuration appears, press Y
  • Now the configuration should be saved and you should be back at the command line interface
  • Enter make -j4 to start compiling, it takes a while

  • Finally, if the output below appears, the compilation is successful

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

Search for Devices​

  • 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 image below is displayed, you can proceed to the next step.
    • If there is no feedback information, this is a system problem of the host machine, and we are unable to help. You need to replace a confirmed normal system or replace the host machine.
    • If there is a prompt saying that the lsusb command does not exist, you can execute the following command to install it: 
      sudo apt-get install usbutils
  • 1d50:614e belongs to the device you will use this time. The suffix OpenMoko, Inc. stm32f407xx has certain reference value but is not used as a basis for judgment.
    • Some host machines may display incompletely or not at all due to system problems.
    • If the device can be displayed by entering the lsusb command, but without 1d50:614e, please try replacing the data cable and connecting the motherboard to another USB port on the host machine.
  • If you have executed the above steps before and successfully burned the Klipper firmware, and the motherboard is running normally, and you just want to update the Klipper firmware, please directly refer to the Firmware Update section in the right-hand menu bar of this page.
Note

You must query one of the 1d50:614e devices before proceeding to the next step.

Flash Firmware​

tip
  • When installing the programming plugin, please ensure your host machine is connected to the internet.
  • If you have already installed it, there is no need to install it again.

Start Programming​

Warning
  • For non-fly host machines, please make sure to run the following code to install the dependencies for firmware programming! Otherwise, the firmware cannot be programmed!
cd && git clone https://github.com/Arksine/katapult.git

  • Use the command below to search for your device ID, and it should display the ID as shown in the image (Note: The ID in the image is for reference only; each motherboard has a different ID).

    ls /dev/serial/by-id/*

  • To program the firmware, use the code below. Make sure the firmware has been compiled, and 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>

  • Below is a reference:

  • After programming is complete, refer to:

Firmware Update​

  • Use the command below to search for your motherboard ID, and it should display the ID as shown in the image (Note: The ID in the image is for reference only; each motherboard has a different ID).
ls /dev/serial/by-id/*
Note

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

  • To update the USB firmware, after compiling the latest firmware, input the command below. 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 Programming​

  • Power off the motherboard, then power it on again and quickly click reset twice.
  • Or use Windows to clean the firmware and reprogram BL.

Confirm if Firmware Has Started​

  • If the firmware starts up normally, the LED will light up