Skip to main content

USB Bridge CAN Firmware Burning

Start Compilation​

  • A host machine with the installed klipper service is required Connect via SSH over the network
  • Make sure the device is connected to the host machine
  • Note: Please use a regular host machine, such as a Raspberry Pi FLY board, etc. If it's a modified host machine (e.g., WiFi stick, Redmi, etc.), due to too many issues, we cannot provide technical support for these machines
warning
  • To switch from the ROOT user to a regular user, you can enter the command below
  • Do not use the ROOT user
  • For the fly user, you can directly enter: su fly. For non-fly users, please replace <your host machine username> with your host machine's username!
su <your host machine username>

::: tip

  • Please ensure that the host machine can connect to the network normally.
  • Before compiling the firmware, use SSH to log in to the host machine via the network.
  • Do not use a serial port tool to log in to the host machine.

:::

Klipper Firmware Compilation and Configuration Page Operation Instructions​

::: tip

Please make sure that the keyboard input method is in half-width mode, i.e., English mode.

:::

  1. The key ↑ (up arrow) and ↓ (down arrow) on the keyboard are used to move the cursor up and down to select menu items.
  2. The confirm key Enter or spacebar Space is used to check the menu or enter a sub-menu.
  3. The exit key ESC is used to return to the previous menu.
  4. The Q key is used to exit the Klipper firmware configuration page.
  5. When exiting the Klipper firmware configuration page and there is a prompt, press the Y key to save the configuration file.

::: warning

If there are fewer options in the configuration page, please first check [ ] Enable extra low-level configuration options to display some hidden options.

:::

Below is the introduction on how to compile the firmware:

  • After connecting to SSH, input the following command 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 previous compilation data and firmware. make menuconfig is to compile the firmware. After execution, the following interface should appear

  • Select Enable extra low-level configuration options and press Enter

  • Enter the menu Micro-controller Architecture then select STMicroelectronics STM32 and press Enter

Images are being updated

  • Enter the menu Processor model, select STM32F405 and press Enter

  • Select Bootloader offset, select: 32KiB bootloader

  • Select Communication interface, select: USB to CAN bus bridge (USB on PA11/PA12)

  • Choose CAN bus interface (CAN bus (on PB8/PB9)) according to the picture

  • Press Q key, Save configuration will appear, then press Y key

  • The configuration should now be saved and you should exit to the command line interface

  • Input make -j4 to start compilation, it takes some time

  • If the following content is output, the compilation is successful

    Linking out/klipper.elf
    Creating hex file out/klipper.bin

Firmware Burning​

tip

Execute the following command to burn the firmware

sudo fly-flash -d gemini-v3 -h -f ~/klipper/out/klipper.bin