Wired Connection Klipper Configuration

Note

• The STM32F072 firmware needs to be flashed before connecting to Klipper, otherwise wired connection is not supported

Start Compilation

• A host computer with the klipper service installed is required Connect via SSH over the network
• And the device is connected to the host computer
• Note: Please use a regular host computer, such as Raspberry Pi FLY. If it is a modified host computer (such as a WiFi stick, Redmi, etc.), due to too many issues, we cannot provide technical support

FlyOS-Armbian system and general system notes

warning

• Notes on FlyOS-Armbian system and general system
  • Ordinary host computer systems such as Raspberry Pi, FLY are viewed in this category
  • Do not use the ROOT user for any operations on these host computers
  • Please use a normal user for operations
  • To switch users, for FlyOS-Armbian system use the su fly command to switch to a normal user
  • For other systems, use the su <your host computer username> command to switch to a normal user

  su <your host computer username>

FlyOS-FAST system notes

warning

• Notes on FlyOS-FAST system
  • The default username for FAST system is root, password is mellow
  • Compiling firmware can only be done using the root user
  • And FAST system only has ROOT user, you don't need to switch users!!!

::: 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 an introduction on how to compile the firmware:

• After connecting to SSH, enter the following command and press Enter:

  cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig

• Where rm -rf ~/klipper/.config && rm -rf ~/klipper/out is to delete previous compilation data and firmware, and 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

  

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

  

• Select Bootloader offset, select: (No bootloader)

  

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

  

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

  

• The configuration should now be saved and exited back to the command line interface

• Enter make -j4 to start the compilation, which will take some time

  

• If the following content is output at the end, the compilation was successful

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

Enter Flashing Mode

• With the AirClick powered off, press and hold the STM32 BOOT button and connect the STM32 flashing port to the host computer via Type-C
  

Confirm Entry into Flashing Mode

• Make sure the host computer can connect to the internet normally

• Make sure the data cable connecting the lower machine to the host computer has data transmission function

• After SSH connects to the host computer, enter lsusb and press Enter. The following three situations may appear

  • Displays the USB devices that have been identified
  • Prompts that there is no ls command, you can execute this command to install

    sudo apt-get install usbutils

  • No error message, no other information (system issue requires changing the system)

• After entering lsusb, there is no response. This is a system issue, and we cannot do anything about it. You need to replace it with a confirmed normal system

• If the information circled in the picture below appears, you can proceed to the next step

  

• 0843:df11 belongs to the device you need to use this time. The following prompts you don't need to care about, because system issues may cause it to display incompletely or not display at all

• If not, please check by yourself whether the data cable is connected properly or whether the motherboard has entered DFU

Notes

Proceed to the next step only when there is 0483:df11

Flash Firmware

1. Install the burning tool

• No need to execute the installation of the burning tool for the FLY upper computer
• If you need to install, please note: The upper computer needs to be able to access the internet to install normally
• If already installed, no need to install

sudo apt update
sudo apt install dfu-util -y

2. Execute the following command to check if the connection is successful.

lsusb

• If there is no DFU device, please try to re-enter burning mode

• Due to system version issues, it may display other names. If 0483:df11 is shown, it indicates entering burning mode

  

3. Burn the firmware

• Execute the code below to start burning

sudo dfu-util -a 0 -d 0483:df11 --dfuse-address 0x08000000 -D ~/klipper/out/klipper.bin

4. If the content shown at the arrow in the following image is File downloaded successfully, then the burning is successful

tip

After burning, the main board needs to be completely powered off once.

Search for USB ID

• Connect the AirClick flashing port to the host computer's USB port. Do not hold the BOOT button, otherwise the ID cannot be searched
  

Notes

Important

• Ensure the tool board has been flashed with USB firmware before performing any operations;
• This tutorial is only applicable for searching the tool board ID, not for searching the main board ID;
• Please perform subsequent operations only after the host computer is properly connected to the tool board;

Connect to SSH

• Please first log in to SSH via the network
• Please ensure that you are logging in to SSH via the network, not via serial port

Search for Device

• Please ensure the host computer is connected to the Internet and that the data cable connecting the device to the host computer supports data transfer.
• After SSH connecting to the host computer, enter lsusb and press Enter. If you see the information circled in the image below, you can proceed to the next step.
  • If no information is displayed, this indicates a system issue with the host computer. We cannot assist with this, and you will need to replace the system with a confirmed working one or change the host computer.
  • If the lsusb command is not found, install it by running the following command:

    sudo apt-get install usbutils

    
• 1d50:614e is the device you will use in this process.
  • Some host computers may fail to fully display or not display the information due to system issues.
  • If the device is shown after running the lsusb command but 1d50:614e is missing, try using a different data cable or connect the main board to another USB port on the host computer.

Note

You must proceed to the next step only after one of the 1d50:614e devices is found.

Search for USB ID

ls /dev/serial/by-id/*

• Enter the command below and press Enter. If everything works properly, a blue ID like the one below will appear. (The example below is just for reference)

• If no ID appears after entering the command, but the device appears with lsusb, please change the host computer or its operating system

Note

If multiple IDs appear, please choose the corresponding ID based on your main board's MCU model.

Insert the USB ID into the configuration

fluidd is: {…}, click into it and you can find printer.cfg

mainsail is: Machine, click into it and you can find printer.cfg

dangerous

Note: All IDs appearing in this document are examples. Each main board's ID is different in practice. Please modify and enter according to the actual ID you obtained.

Enter the Tool Board USB ID

• Below is a sample configuration

  Note

  • The toolboard in the configuration below refers to the tool board name; please replace it with the appropriate name if it is different
  dangerous

  [mcu toolboard]
  serial: <Replace this with the ID you just looked up>

  • To add the ID of the tool board, it must be [mcu toolboard] followed by serial: and then the ID of the tool board you searched for
  • Below is a sample configuration
  • Please note that this tutorial is specifically for searching and configuring the tool board ID; normally, it should already be connected to the main board
  • And the main board must be [mcu], while the tool board is [mcu toolboard]

  Fluidd reference

  Mainsail reference

  • Click SAVE & RESTART at the top right corner, which will automatically save and restart klipper