Firmware Compilation Instructions

Important Safety Notice

To ensure stable system operation, please strictly follow the following firmware usage principles:

• Firmware Compilation Consistency: The Klipper firmware must be compiled by the host computer currently in use. Using firmware compiled by others or with mismatched versions may cause unpredictable system failures.
• Hardware Platform Specifications: It is strongly recommended to use standard host computer hardware. Avoid using unofficially modified devices (e.g., certain set-top boxes, WiFi dongles, or specific Redmi models), as these may have compatibility and stability risks.
• Virtualization Environment Limitations: Running the host computer system in a virtual machine is not recommended, as it may introduce performance and real-time interference, affecting print quality.

Firmware Type Description

• Katapult / HID Mode

  • Function: These two modes have identical functionality, both enabling contactless firmware flashing (no need to insert or remove an SD card; firmware can be updated directly through the host computer).
  • Description: HID is the Bootloader used by FLY onboard host computers, and is essentially the same as Katapult.
  • Important Tip: When using Katapult, if the motherboard becomes unresponsive due to incorrect firmware flashing, locate the reset button on the motherboard and quickly double-press it twice, to re-enter Katapult mode for re-flashing.

• Bootloader Mode

  • Function: The traditional method of flashing via SD card.
  • Advantage: This method has strong fault tolerance. If an incorrect firmware is accidentally flashed, you can re-flash by simply reusing the SD card, without worrying about bricking the motherboard.

Firmware Compilation Guide

Compilation Preparation and Recommendations

• To maximize compilation success, it is recommended to use MobaXterm as your SSH client. According to user feedback, some SSH tools may cause unknown compilation errors.
• Important Configuration Option: In the configuration interface, ensure the Enable extra low-level configuration options option is checked; otherwise, some advanced settings will not be visible.

Startup Pin Configuration (GPIO pins to set at micro-controller startup)

Important Notice

• This option is used to forcibly set the voltage state of specific GPIO pins at micro-controller startup.
• You need to switch to an English input method, otherwise firmware compilation will fail.

• Configuration Syntax:

  • Adding ! before a pin name means pulling that pin low (low voltage level) at startup; without !, it means pulling the pin high (high voltage level).
  • STM32 Series: Pin numbers must be in uppercase (e.g., !PF8 or PF8).
  • RP2040 Series: Pin numbers must be in lowercase (e.g., !gpio5 or gpio5).

• Multiple Pin Configuration: If configuring multiple pins, separate them with commas ,.

  • Example: !gpio5,!gpio19,gpio24 means pulling gpio5 and gpio19 low, and gpio24 high at startup.

Safety Notice

The GPIO pins to set at micro-controller startup configuration only takes effect before Klipper connects and initializes. Once Klipper successfully connects and runs normally, this setting will not affect any other operations of the pins. It is safe to use.

Firmware Flashing Failure Recovery and General Protection

• Protection against Incorrect Firmware Flashing: The Katapult, HID, and Bootloader firmware types each have built-in protection mechanisms. As long as special DFU mode is not entered for flashing, even if the main firmware is incorrectly flashed, these bootloaders will not be overwritten, and the motherboard will not be bricked.
• Required Operation After Flashing: After any firmware flashing, it is essential to completely power off the micro-controller (unplug the power cable), then power it on again, to ensure the new firmware is correctly loaded and running stably.

Firmware Flashing Instructions

Important Notes Before Flashing

• Device Recognition: When using Katapult for flashing, ensure the host computer can detect the device. If the device is not found, quickly double-press the reset button on the motherboard to re-enter flashing mode.
• Follow Official Procedures: Please strictly follow the official tutorial's flashing method. Using unverified methods may cause device damage.
• Compilation Check: Before flashing, ensure the firmware has no compilation errors, as incorrect firmware files may cause flashing failure or device malfunction.

Recovering from Incorrect Katapult Firmware Flashing

1. Locate the physical reset button on the motherboard and quickly double-press it.
2. Under normal circumstances, an LED on the Fly motherboard will start blinking, indicating successful entry into Katapult mode.
3. At this point, you can clear the incorrect firmware from the motherboard and re-flash the correct Klipper firmware.

Recovering from Incorrect Bootloader Firmware Flashing

1. Reinsert the TF card containing the correct firmware into the motherboard.
2. If flashing fails, first completely power off the system, insert the TF card, then power it back on.
3. Keep the device powered for about 5 seconds, allowing automatic firmware update to complete.