Skip to main content

Firmware Compilation Guide

Important Safety Notice

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

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

Firmware Type Description​

  • Katapult / HID Mode

    • Function: Both modes function identically, enabling contactless flashing (updating firmware directly via the host computer without inserting/removing a memory card).
    • Note: HID is the Bootloader used by the FLY onboard host computer and is essentially the same as Katapult.
    • Important Tip: When using Katapult, if flashing an incorrect firmware causes the mainboard to become unresponsive, locate the reset button on the mainboard and quickly double-click it to re-enter Katapult mode for re-flashing.

  • Bootloader Mode

    • Function: The traditional method of flashing via a memory card.
    • Advantage: This method offers high fault tolerance. If you accidentally flash the wrong firmware, you can simply re-flash the memory card and try again without worrying about "bricking" the mainboard.

Firmware Compilation Guide​

Compilation Preparation and Recommendations
  • To maximize the chance of successful compilation, we recommend using MobaXterm as your SSH client. According to user feedback, some SSH tools may cause unknown compilation errors.
  • Important Configuration Item: In the compilation configuration menu, make sure to check the Enable extra low-level configuration options option, otherwise some advanced settings will not be displayed.

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

Important Note
  • This option is used to force the level state of specific GPIO pins when the microcontroller starts.
  • You must switch to English input mode, otherwise the firmware cannot be compiled.

  • Configuration Syntax:

    • Adding ! before a pin indicates pulling the pin low (low level) at startup, while omitting ! indicates pulling it high (high level).
    • STM32 Series: Pin numbers must be in uppercase format, fill in according to your actual mainboard documentation.
    • RP2040 Series: Pin numbers must be in lowercase format, fill in according to your actual mainboard documentation.

  • Multiple Pin Configuration: To configure multiple pins, separate them with an English comma ,.

    • Example: !<pin_a>,!<pin_b>,<pin_c> means pulling the first two pins low and the third pin high at startup.
Safety Note

The GPIO pins to set at micro-controller startup you configure only take effect before Klipper establishes a connection. Once Klipper connects and runs normally, this setting will not affect any other operations of the pins, so it is safe to use.

Flash Failure Recovery and General Protection
  • Protection Against Wrong Firmware: The Katapult, HID, and Bootloader firmware types themselves have protective mechanisms. As long as you do not enter a special DFU mode for flashing, even if the main firmware is flashed incorrectly, these bootloaders will not be overwritten, and the mainboard will not be "bricked".
  • Necessary Post-Flash Action: After any firmware flashing is complete, make sure to completely power off the secondary device (unplug the power cable), then power it back on to ensure the new firmware is correctly loaded and runs stably.

Firmware Flashing Guide​

Before Flashing
  • Device Recognition: When using Katapult for flashing, ensure the host computer can recognize the device. If the device cannot be found, quickly double-click the reset button on the mainboard to re-enter flashing mode. Alternatively, re-flash the mainboard's BL firmware.
  • Follow Guidelines: Strictly follow the official tutorial's flashing method. Using other unverified methods may cause device damage.
  • Compilation Check: Before flashing, make sure the firmware has no compilation errors. An incorrect firmware file will cause flashing to fail or the device to malfunction.

Katapult Firmware Flash Failure Recovery​

  1. Locate the physical reset button on the mainboard and quickly double-click it.
  2. Under normal circumstances, an LED indicator light on the Fly mainboard will start blinking, indicating successful entry into Katapult mode.
  3. You can now enter Katapult mode and re-flash the correct Klipper firmware.

Bootloader Firmware Flash Failure Recovery​

  1. Re-insert the TF card containing the correct firmware into the mainboard.
  2. If flashing fails, first completely power off, insert the TF card, and then power on again.
  3. Keep it powered on for approximately 5 seconds to complete the automatic flashing.

Install Katapult Flashing Dependencies​

Important
  • If you are using a non-Fly official host computer, make sure to run the following command to install the firmware flashing dependency package!
  • Choose one of the repositories below.
  • GitHub Repository 
    cd && git clone https://github.com/Arksine/katapult.git
  • China Region Mirror Repository 
    cd && git clone https://cnb.cool/3dmellow/public/katapult
Loading...
Loading...