RS232 Firmware Compilation

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

• 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 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 Note that ! is uppercase
  
• Press the Q key, and Save configuration appears, then press Y key
  
• Now the configuration should be saved and return to the command line interface
• Enter the following command to start compiling, it takes some time

make -j4

• If the output is as follows, the compilation is successful

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

Enter Flashing Mode

tip

The top one is the RESET button, the bottom one is the BOOT button

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

Confirm Whether Entering Flashing Mode

• Make sure the host computer can connect to the internet normally

• Make sure the data cable connecting the lower machine to the host computer has data transmission function

• After SSH connects to the host computer, enter lsusb and press Enter. The following three situations may appear

  • Displays the USB devices that have been identified
  • Prompts that there is no ls command, you can execute this command to install

    sudo apt-get install usbutils

  • No error message, no other information (system issue requires changing the system)

• After entering lsusb, there is no response. This is a system issue, and we cannot do anything about it. You need to replace it with a confirmed normal system

• If the information circled in the picture below appears, you can proceed to the next step

  

• 0843:df11 belongs to the device you need to use this time. The following prompts you don't need to care about, because system issues may cause it to display incompletely or not display at all

• If not, please check by yourself whether the data cable is connected properly or whether the motherboard has entered DFU

Notes

Proceed to the next step only when there is 0483:df11

Flash 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

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

  

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

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

3. Flash Firmware

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

4. If the content shown in the arrow in the following figure appears File downloaded successfully then the flashing is successful

   

tip

After the firmware is flashed, the board needs to be completely powered off once.

Confirm Whether the Firmware Starts

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