USB Firmware Compilation

SSH Connection to the Upper Computer

Warning

Before compiling the firmware, connect to the upper computer via SSH using WiFi

First, please: Connect to the upper computer via WiFi using SSH

USB Firmware Flashing
Manually Compile USB Firmware

USB Firmware Flashing

Note

A USB firmware has already been pre-compiled in the FLYOS-FAST system, no need to manually compile it again. Execute the command below to flash it.
You can also choose Manually compile USB firmware to compile the firmware yourself.

Enter the following command via SSH connection to the upper computer

fly-flash -d auto -h -f /usr/lib/firmware/klipper/stm32f407-32k-usb.bin

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

Starting Firmware Compilation

Below is an introduction on how to compile the firmware:

Connect via SSH, enter the following command, and press Enter:
```
cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig
```
Here, rm -rf ~/klipper/.config && rm -rf ~/klipper/out is used to clear previous compilation configurations and firmware; make menuconfig is used to open the Klipper firmware configuration interface.
Follow the order below to set each item one by one, completing each before moving on to the next.

1启用 Enable extra low-level configuration options
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
2Micro-controller Architecture 选择 STMicroelectronics STM32
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
3Processor model 选择 STM32F407
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
4Bootloader offset 选择 32KiB bootloader
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
5Clock Reference 选择 8 MHz crystal
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
6Communication interface 选择 USB (on PA11/PA12)
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
7USB ids 保持默认，无需进入
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
8启用 Optimize stepper code for 'step on both edges'
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
9GPIO pins to set at micro-controller startup 保持为空
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
10GPIO state at micro-controller startup 选择 Not set
此项是 FLYOS-Klipper 功能。通常保持 Not set；如需设置全部 GPIO 的启动状态，请先阅读 GPIO 启动状态使用说明。
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
11按 Q 键退出配置界面
(Top)
Klipper Firmware Configuration
[*] Enable extra low-level configuration options
Micro-controller Architecture (STMicroelectronics STM32) --->
Processor model (STM32F407) --->
Bootloader offset (32KiB bootloader) --->
Clock Reference (8 MHz crystal) --->
Communication interface (USB (on PA11/PA12)) --->
USB ids --->
[*] Optimize stepper code for 'step on both edges'
() GPIO pins to set at micro-controller startup
GPIO state at micro-controller startup (Not set) --->
12出现 Save configuration 时按 Y 保存配置
Quit
Save configuration?
(Y)es(N)o(C)ancel
After completing the last two steps above, press Q to exit the configuration interface, then press Y to save the configuration.
Return to the command line and enter the following command, then press Enter to start compiling:
```
make -j4
```
root@flyos-11e5f8 ~/klipper # make -j4
Compiling out/src/stm32/spi.o
Compiling out/src/stm32/i2c.o
Compiling out/src/stm32/usbotg.o
Compiling out/src/stm32/chipid.o
Compiling out/src/generic/usb_cdc.o
Compiling out/src/stm32/hard_pwm.o
Compiling out/src/stm32/sdio.o
Preprocessing out/src/generic/armcm_link.ld
Building out/compile_time_request.o
Version: XXXX
Linking out/klipper.elf
Creating bin file out/klipper.bin
终端末尾出现 Linking out/klipper.elf 和 Creating bin file out/klipper.bin，即表示编译成功。实际编译时，部分 Compiling 行和 Version 会随 Klipper 与系统版本变化。

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.

SSH Connection to the Upper Computer​

USB Firmware Flashing​

Brief Guide to Firmware Compilation​

Notes​

SSH Login and User Switching​

Switch User:​

Firmware Compilation Operation Guide​

Starting Firmware Compilation​

Firmware Flashing​

Searching for USB ID​

Filling in the USB ID​