Wired Connection Klipper Configuration

Important

The STM32F072 needs to be flashed with firmware before connecting to Klipper; otherwise, wired connection operations are not supported.

Start Compilation

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
FAST System Firmware Compilation Guide

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>

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.

:::

The key ↑ (up arrow) and ↓ (down arrow) on the keyboard are used to move the cursor up and down to select menu items.
The confirm key Enter or spacebar Space is used to check the menu or enter a sub-menu.
The exit key ESC is used to return to the previous menu.
The Q key is used to exit the Klipper firmware configuration page.
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 via SSH, enter the following command and press Enter:

cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig

Among these, rm -rf ~/klipper/.config && rm -rf ~/klipper/out deletes previous compilation data and firmware.
make menuconfig is for compiling the firmware. After execution, the following interface should appear:

Loading...
Select Enable extra low-level configuration options and press Enter:

Loading...
Enter the menu Micro-controller Architecture, then select STMicroelectronics STM32 and press Enter:

Loading...
Enter the menu Processor model, select STM32F072, and press Enter:

Loading...
Select Bootloader offset, choose: (No bootloader):

Loading...
Communication interface, select: USB (on PA11/PA12):

Loading...

Press the Q key. When Save configuration appears, press the Y key.
Loading...
The configuration should now be saved, and you should return to the command line interface.
Enter make -j4 to start compilation. This will take some time.
Loading...
If the following content is output at the end, the compilation is successful.
Due to Klipper version differences, the appearance of out/klipper.bin indicates success.
```
Linking out/klipper.elf
Creating bin file out/klipper.bin
```

Enter Flash Mode

With the AirClick powered off, hold the BOOT button on the STM32 and connect the STM32's programming port to the host computer via Type-C.
Loading...

Confirm Entry into Flash 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

Loading...
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 the Firmware

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

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

Loading...

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

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.

Search for USB ID

Connect the AirClick's programming port to the host computer's USB port. Do not hold the BOOT button, otherwise the ID cannot be searched.
Loading...

Precautions

Important Notes

Must connect to the host computer via SSH. Please use network login to connect to the host computer (such as Raspberry Pi and other devices).
Before operation, ensure the mainboard has been flashed with the USB firmware.
This tutorial is only applicable for Mainboard ID search, not for Toolboard ID search.
Please confirm the mainboard is connected to the host computer's USB port via TYPEC.
To view the Toolboard ID, please refer to the relevant tutorial in the corresponding product directory.

Operation Steps

Search for USB Device ID

Execute the following command to list all USB serial device IDs:
```
ls /dev/serial/by-id/*
```

⚠️ Important Note: Unusable IDs

After executing the command, please identify and avoid using the following two types of IDs:

ID Characteristics	Reason Explanation	Example
`usb-1a86_USB_Serial-if00-port0`	This is the default name for generic serial chips like CH340, cannot be used for configuration.	/dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
Contains `katapult`	Indicates the device is in bootloader mode. It needs to be flashed with Klipper firmware before use.	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Execution Result Explanation:

Normal Situation: The terminal will display an ID similar to the example below (the image is for illustration only).
Loading...
Troubleshooting for Abnormal Issues

Handling Multiple IDs

If multiple IDs appear, please select the corresponding ID based on your mainboard's MCU model.

Fill the USB ID into the Configuration

For fluidd: {…}. Click into it to find printer.cfg.

For mainsail: Machine. Click into it to find printer.cfg.

Note: All IDs appearing in the documentation are examples. The actual ID for each mainboard is different. Please modify and fill in according to the ID you actually obtained.

Fill in the USB ID

Find [mcu], then replace it.

Note

Please replace in the configuration file:
Do not configure canbus_uuid:.

[mcu]
serial: <Replace here with the ID you just queried>

Reference

Reference for fluidd

Reference for mainsail

Click the SAVE & RESTART button in the upper right corner. After clicking, it will automatically save and restart Klipper.

Start Compilation​

Klipper Firmware Compilation and Configuration Page Operation Instructions​

Enter Flash Mode​

Confirm Entry into Flash Mode​

Flash the Firmware​

Search for USB ID​

Precautions​

Operation Steps​

Search for USB Device ID​

⚠️ Important Note: Unusable IDs​

Execution Result Explanation:​

Fill the USB ID into the Configuration​

Fill in the USB ID​