RS232 Firmware Compilation

Start Compiling

• A host computer with the klipper service installed Connect via SSH over network
• And the device should be properly connected to the host computer
• Note: Please use a standard host computer, such as Raspberry Pi, FLY board, etc. If it is a modified host computer (e.g., WiFi dongle, Redmi devices), we cannot provide technical support due to numerous issues with such hosts

Firmware Compilation Guide for Standard Host

warning

• Applies to standard host computers running systems like Raspberry Pi, FLY board, etc.
• Do not use the ROOT user for any operations on such hosts
• Please perform operations using a regular user account
• To switch users, for the FlyOS-Armbian system, please use the command su fly to switch to the regular user
• For other systems, use the command su <your host username> to switch to the regular user

su <your host username>

FAST System Firmware Compilation Guide

warning

• Notes for the FlyOS-FAST system
  • The default username for the FAST system is root, and the password is mellow
  • Firmware compilation must be performed using the root user
  • The FAST system only has the ROOT user—you do not need to switch users!!!

::: 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 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 and then select Raspberry Pi RP2040/RP235x and press Enter

  

• Select Bootloader offset, choose: NO bootloader

  

• Select Communication interface, choose: UART0 on GPIO0/GPIO1

  

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

warning

Please enter !gpio18 in English input mode

• Press the Q key, and Save configuration appears, then press Y key

• Now the configuration should be saved and you should return to the command line interface
• Enter the following command to start compiling, it takes some time

make -j4

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

  Linking out/klipper.elf
  Creating uf2 file out/klipper.uf2

Enter Burn Mode

tip

The arrow points to the BOOT button

• With the tool board completely powered off, hold the BOOT button, use a TypeC data cable with data transfer function, connect the tool board to your host computer's USB port, and release the BOOT button after correctly connecting to the host computer
  

Confirm Whether It Has Entered Burn Mode

• Please ensure that the host machine can connect to the network normally, and ensure that the data cable connecting the peripheral machine to the host machine has data transmission function.
• After SSH connecting to the host machine, enter lsusb and press Enter. If the information circled in the following image is displayed, you can proceed to the next step.
  • If there is no feedback information, this indicates a system issue with the host machine, and we are unable to help. 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

    
• 2e8a:0003 belongs to the device you will be using this time. The suffix Raspberry Pi RP2 Boot has some reference value but is not used as a basis for judgment.
  • Some host machines may display incompletely or not at all due to system issues.
  • If entering the lsusb command displays the device but does not show 2e8a:0003, please try replacing the data cable and attempt to connect the motherboard to another USB port on the host machine.

Note

You can only proceed to the next step when there is 2e8a:0003.

Burn RS232 Firmware

• Please note that the current toolboard is in firmware burning mode and can only burn firmware with a .uf2 suffix.
• Use the following command to burn the firmware to the toolboard.

cd && cd ~/klipper/
make flash FLASH_DEVICE=2e8a:0003

tip

If this is the first burn after writing the system with the host machine, you may see a prompt similar to the one circled in red below — partial red prompts are normal and not an error.

Confirm Whether the Firmware Has Started

• If the firmware starts normally, the LED shown in the figure below will light up