USB Firmware Compilation

Firmware Compilation Quick Guide

Precautions

Network: Ensure the host machine (Raspberry Pi, etc.) is connected to the network.
Login Method: Must log in via SSH over the network; serial port login is disabled.
Input Method: Keep the keyboard in English half-width mode.

Use tools like MobaXterm, PuTTY, etc., to SSH into the host machine.

Switching Users:

Standard Systems (Official Raspberry Pi OS, etc.)
Do not use root. Switch to a regular user:
```
su <username>
```
FLY Host Machine (FlyOS-FAST System)
Only supports logging in as the root user (password: mellow).

Firmware Compilation Operation Guide

In the Klipper firmware configuration interface, only keyboard operations are supported; mouse usage is not possible.

Key	Function
↑ / ↓	Move cursor up/down to select menu items
Enter / Space	Confirm selection, toggle options, or enter submenus
ESC	Return to the previous menu level
Q	Exit the configuration interface
Y	When exiting, press Y to save the configuration if prompted

Start Firmware Compilation

The following describes 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 interface below should appear.

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

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

Loading...
Enter the Processor model menu, select STM32F405, and press Enter.

Loading...
Select Bootloader offset, choose: 32KiB bootloader.

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

Loading...

Press the Q key, and Save configuration will appear. Then press the Y key.
Loading...
The configuration should now be saved, and you will exit to the command line interface.
Enter the command below to start compilation. This will take some time.

make -j4

Finally, if the output shows the following content, the compilation is successful.
Due to Klipper version differences, as long as out/klipper.bin appears, it indicates success.
```
Linking out/klipper.elf
Creating bin file out/klipper.bin
```

Firmware Flashing

tip

Execute the following command to flash the firmware

fly-flash -d auto -h -f /data/klipper/out/klipper.bin

Searching for USB ID

Open a browser, enter the IP address of the host computer in the address bar. For example, if the host IP is 192.168.101.179, type it directly and press Enter.

Access the host's WEB interface. In the configuration options on the left sidebar, find:

For fluidd: {…}, click to enter and find printer.cfg

For mainsail: Machine, click to enter and find printer.cfg

Click on printer.cfg, then click DEVICES in the top right corner.

Click SERIAL, then refresh.

Refresh in fluidd

Refresh in mainsail

Copy the ID. Click where indicated by the arrow to copy.

In fluidd, check if ttyAMC exists and ensure Path by ID is present. This is the USB ID.

In mainsail, check if ttyAMC exists and ensure Path by ID is present. This is the USB ID.

Filling in the USB ID

dangerous

The ID below is NOT usable!!!!

serial: /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0

Close DEVICES and fill in the ID.

Important Notes

In the configuration file, change:

[mcu] 
serial: /tmp/klipper_host_mcu

[mcu host] 
serial: /tmp/klipper_host_mcu

And add:

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

Find [MCU] in fluidd

Find [MCU] in mainsail

Fill the ID into the configuration.

tip

After filling in the ID, click SAVE & RESTART in the top right corner.

If Klipper reports ADC out of range, this is normal. Connect the heated bed and thermistor to the mainboard, configure the thermistor pins for the hotend and heated bed, then save and restart.

dangerous

Note: All IDs appearing in this document are examples. The actual ID for each mainboard is different. Please fill in the ID you actually obtained.

Firmware Compilation Quick Guide​

Precautions​

SSH Login and User Switching​

Switching Users:​

Firmware Compilation Operation Guide​

Start Firmware Compilation​

Firmware Flashing​

Searching for USB ID​

Filling in the USB ID​