Skip to main content

USB Firmware Compilation

tip
  • ERCF factory pre-flashed CAN-connected Katapult firmware
  • If using USB firmware burning, you need to burn the USB Katapult firmware
  • No need to burn again after one time
  • Katapult Firmware Burning

Start Compilation​

  • 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 internet normally.
  • Before compiling the firmware, you need to log in to the host machine via SSH through 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 ensure that the keyboard input method is in half-width mode, i.e., English mode.

  1. The key ↑ on the keyboard is used for moving the cursor up, and the key ↓ is used for moving the cursor down to select menu items.
  2. The confirmation key Enter or the space key Space is used to check a menu item or enter a sub-menu.
  3. The exit key ESC is used to return to the previous menu level.
  4. The Q key is used to exit the Klipper firmware configuration page.
  5. When exiting the Klipper firmware configuration page and there are prompts, 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 Raspberry Pi RP2040 and press Enter

  • Select Bootloader offset, select: No bootloader

  • Communication interface, select: USBSERIAL

  • Select GPIO pins to set at micro-controller startup, enter: gpio17

  • Press Q key, and when Save configuration appears, press Y key

  • Now the configuration should be saved and you should exit to the command line interface

  • Enter make -j4 to start compilation, it takes some time

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

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

Confirm if Entering Burning Mode​

  • Please ensure that the host machine can connect to the network normally, and ensure that the data cable connecting the sub-machine to the host machine has data transmission capabilities.
  • After SSH connecting to the host machine, enter 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 indicates a system problem with the host machine, and we are unable to assist. You need to replace it 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 be using this time. The suffix OpenMoko, Inc. stm32f407xx has some reference value but is not used as a basis for judgment.
    • Some host machines may display incomplete or no information due to system problems.
    • If entering the lsusb command displays the device but does not show 1d50:6177, please try replacing the data cable and attempt to connect the motherboard to another USB port on the host machine.
  • If you have executed the above steps previously and successfully burned the Klipper firmware, and the motherboard is running normally, but you just need 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 the 1d50:6177 device before proceeding to the next step.

Burn 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​

  • 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>

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

Confirm if Firmware Starts​

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