USB Firmware Compilation

Brief Guide to Firmware Compilation

Notes

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

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

Switch User:

Standard System (Official Raspberry Pi system, etc.)
Do not use root; switch to a regular user:
```
su <username>
```
FLY Host System (FlyOS-FAST system)
Only supports login as root user (password: mellow)

Firmware Compilation Operation Guide

In the Klipper firmware configuration interface, only keyboard operations are supported; the mouse cannot be used.

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

Start Firmware Compilation

The following describes how to compile the firmware:

After connecting via SSH, enter the command below 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 the 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 STM32F405 and press Enter

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

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

Loading...

Press the Q key, when Save configuration appears, then press the Y key.
Loading...
The configuration should now be saved and you have exited to the command line interface.
Enter the following command to start compiling. It will take a while.

make -j4

Finally, if the following output appears, the compilation is successful.
Due to the Klipper version, as long as out/klipper.bin appears, it means 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 my host computer IP is 192.168.101.179, directly input it and press Enter.

Open the WEB interface of the host computer, and find the following in the configuration options of the left sidebar:

For fluidd: {…}, click to enter, then you can find printer.cfg

For mainsail: Machine, click to enter, then you can find printer.cfg

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

Click SERIAL, then refresh.

Refresh in fluidd

Refresh in mainsail

Copy the ID, click on the arrow indicated to copy.

In fluidd, confirm whether ttyACM exists, and ensure that Path by ID is present. This is the USB ID.

In mainsail, confirm whether ttyACM exists, and ensure that Path by ID is present. This is the USB ID.

Filling in the USB ID

Danger

Please note that the ID below CANNOT be used!!!!

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

Close DEVICES and fill in the ID.

Note

In the configuration file, change:

[mcu] 
serial: /tmp/klipper_host_mcu

[mcu host] 
serial: /tmp/klipper_host_mcu

And add:

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

Find [MCU] in fluidd

Find [MCU] in mainsail

Fill in the ID into the configuration.

Tip

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

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

Danger

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

Brief Guide to Firmware Compilation​

Notes​

SSH Login and User Switching​

Switch User:​

Firmware Compilation Operation Guide​

Start Firmware Compilation​

Firmware Flashing​

Searching for USB ID​

Filling in the USB ID​