Skip to main content

USB Firmware Compilation

tip
  • Micro4 comes with pre-flashed USB-connected Katapult firmware and does not require re-flashing.

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
  • 请确保上位机可以正常联网
  • 固件编译前需要使用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 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, input: gpio8

  • Press the Q key, a Save configuration prompt will appear, then press Y

  • Now you should have saved the configuration and exited to the command line interface

  • Enter make -j4 to start compiling, this takes some time

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

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

Confirm Entering Flash Mode​

  • Ensure the host machine can connect to the internet normally and ensure the data cable connecting the host and the device has data transmission capability.
  • After SSH connection to the host machine, enter lsusb and press enter, if the information circled in the image below appears, you can proceed to the next step.
    • If there is no feedback, this is a system issue with the host machine, we are unable to help, you need to replace with a confirmed normal system or change the host machine.
    • If the instruction lsusb is not recognized, you can execute the following command to install it 
      sudo apt-get install usbutils
  • 2e8a:6177 is the device you will be using. The suffix OpenMoko, Inc. rp2040 provides some reference but is not a basis for judgment.
    • Some host machines may display incompletely or not at all due to system issues.
    • If the lsusb command displays the device but does not show 2e8a:6177, try changing the data cable and connecting the motherboard to another USB port on the host machine.
Note

You can only proceed to the next step when 2e8a:6177 is present.

Flash Firmware​

tip
  • When installing the firmware burning 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 Burning​

Warning
  • For non-fly host machines, please execute the code below to install the dependencies for firmware burning! Otherwise, the firmware cannot be burned! 
    cd && git clone https://github.com/Arksine/katapult.git

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

    ls /dev/serial/by-id/*

  • To burn the firmware, use the command below. Ensure that 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 burning the firmware, refer to the following:

Firmware Update​

  • Use the command below to search for your motherboard ID, which should appear as shown in the image below (Note: The ID shown 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's ID.

  • After compiling the latest firmware, enter the command below to update. Replace <your motherboard ID> with the ID queried in the previous step.

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

How to Fix Incorrect Firmware​

  • Disconnect power from the motherboard, then reconnect it and quickly click the reset button twice on the motherboard.
  • Alternatively, clean the firmware using WINDOWS and then reinstall BL