Skip to main content

RS232 Firmware Compilation

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

  • 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

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

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

Please enter !gpio5 in English input mode

  • Press Q key, Save configuration will appear, then press Y key
  • Now the configuration should be saved and you should have exited 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 uf2 file out/klipper.uf2

Enter Burning Mode​

tip

The left is the RESET button, and the right is the BOOT button

  • There are two ways to enter DFU
  • First method: With the motherboard completely powered off, press and hold the BOOT button and then connect one end of the data cable with data transfer to the motherboard and the other end to the host computer
  • Second method: Connect one end of the data cable with data transfer to the motherboard and the other end to your host computer, press and hold the BOOT key then press the RST key, then release the RST key and finally release the BOOT key

Confirm Whether Entered Burning 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 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 Firmware Starts​

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