Skip to main content

USB Firmware Compilation

tip
  • The USB accelerometer has the USB-connected Klipper firmware pre-flashed at the factory.
  • Only the firmware needs to be updated.
  • A USB cable can be used to connect the computer and the USB accelerometer.

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

  • Select GPIO pins to set at micro-controller startup, input: gpio8
  • Press Q key, a Save configuration prompt will appear, then press Y key
  • Now the configuration should be saved and you are back to the command line interface
  • Enter make -j4 to start compiling, it takes some time
  • If the output below appears, the compilation is successful
  Linking out/klipper.elf
Building out/lib/elf2uf2/elf2uf2
Creating uf2 file out/klipper.uf2

Search for Devices

  • Please ensure that the host computer can connect to the network normally and ensure that the data cable connecting the slave computer to the host computer has data transmission function.
  • After SSH connecting to the host computer, input lsusb and press Enter. If the information circled in the picture below appears, you can proceed to the next step.
    • If there is no feedback at all, this is a system problem of the host computer. We are unable to help. You need to replace it with a confirmed normal system or replace the host computer.
    • If there is no lsusb command prompt, 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.
    • Some host computers may not display fully or fail to display due to system problems.
    • If the device can be displayed after entering the lsusb command but without 1d50:614e, please try replacing the data cable and connecting the mainboard to another USB port on the host computer.
  • If you have executed the above steps before and successfully burned the Klipper firmware, and the mainboard is running normally, but you only want to update the Klipper firmware, please directly refer to the Firmware Update section in the right menu bar of this page.
Note

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

Flash Firmware

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

The reference ID /dev/serial/by-id/usb-Klipper_rp2040_12345-if00 in the image below is the motherboard ID.

  • To update the USB firmware, input the following command after compiling the latest firmware, replacing <your motherboard ID> with the ID queried in the previous step:
cd ~/klipper/ && make flash FLASH_DEVICE=<your motherboard ID>

Solution for flashing the wrong firmware

  • Press and hold the button to enter DFU mode, and the computer will recognize it as a new USB drive; drag the firmware into it.
  • Clean the firmware using WINDOWS and then re-flash the firmware.

Confirm if Firmware is Running

  • If the firmware starts up normally, the LED will light up
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -
- 3D Mellow -