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

  • Among them, rm -rf ~/klipper/.config && rm -rf ~/klipper/out is to delete previous compilation data and firmware. make menuconfig is for compiling 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 STMicroelectronics STM32 and press Enter

  • Enter the menu Processor model, select STM32H723 and press Enter

  • Select Bootloader offset, select: NO bootloader

  • Select Clock Reference (8 MHz crystal), select: 25 MHz crystal

  • For Communication interface, select: Serial (on USART1 PA10/PA9)

  • Select GPIO pins to set at micro-controller startup, input: !PA15 Please note that ! is uppercase

  • 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

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

Enter Burning Mode​

tip

The above is the RESET button, and the below 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 while connecting 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 internet normally.

  • Please ensure that the data cable connecting the lower-level machine to the host machine has data transfer functionality.

  • After SSH connecting to the host machine, input lsusb and press enter. The following three scenarios may occur:

    • It will display the recognized USB devices.
    • It will prompt that there is no ls command; you can execute this command to install it: 
      sudo apt-get install usbutils
    • There is no error message, but also no other information (a system issue requires replacing the system).

  • If there is no reaction after entering lsusb, this is a system issue, and we are unable to help; you need to replace with a confirmed normal system.

  • If the information circled in the following image appears, you can proceed to the next step.

  • 0843:df11 belongs to the device you will be using this time. You do not need to worry about the subsequent prompts as they may not fully display or may not display at all due to system issues.

  • If not, please check whether the data cable is properly connected or if the motherboard has entered DFU mode.

Note

Proceed to the next step only if there is 0843:df11.

Burn Firmware​

  1. Install the burning tool
  • No need to execute the installation of the burning tool for the FLY upper computer
  • If you need to install, please note: The upper computer needs to be able to access the internet to install normally
  • If already installed, no need to install
sudo apt update
sudo apt install dfu-util -y
  1. Execute the following command to check if the connection is successful.
lsusb

  • If there is no DFU device, please try to re-enter burning mode

  • Due to system version issues, it may display other names. If 0483:df11 is shown, it indicates entering burning mode

  1. Burn the firmware
  • Execute the code below to start burning
sudo dfu-util -a 0 -d 0483:df11 --dfuse-address 0x08000000 -D ~/klipper/out/klipper.bin
  1. If the content shown at the arrow in the following image is File downloaded successfully, then the burning is successful
tip

After burning, the main board needs to be completely powered off once.

  1. Burn Firmware

    sudo dfu-util -a 0 -d 0483:df11 --dfuse-address 0x08000000 -D ~/kliper/out/klipper.bin

  2. If the content shown by the arrow in the figure below appears File downloaded successfully, then the burning is successful

tip

After burning is completed, the motherboard needs to be completely powered off once.

Confirm Whether Firmware Starts​

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