Skip to main content

RS232 Firmware Compilation

Before Flashing​

  • The RS232 firmware can only be flashed after the tool board is connected to the host computer via its Type-C port.

Setting the DIP Switches​

  1. Power Off Safely: Ensure the tool board is completely disconnected from the power source before operation.
  2. Locate DIP Switches: Flip the tool board over. Find the group of DIP switches on the back.
  3. Switch Mode: Set all DIP switches to the specified positions for RS232 mode (see image below).
Loading...

Warning

  • If the DIP switch settings are changed, the RS232 firmware must be re-flashed. Otherwise, communication will fail.
  • If the correct firmware has already been flashed previously and the DIP switches have not been changed, re-flashing is not necessary.

Start Compilation​

  • A host computer with the klipper service installed Connect via SSH over network
  • And the device should be properly connected to the host computer
  • Note: Please use a standard host computer, such as Raspberry Pi, FLY board, etc. If it is a modified host computer (e.g., WiFi dongle, Redmi devices), we cannot provide technical support due to numerous issues with such hosts
warning
  • Applies to standard host computers running systems like Raspberry Pi, FLY board, etc.
  • Do not use the ROOT user for any operations on such hosts
  • Please perform operations using a regular user account
  • To switch users, for the FlyOS-Armbian system, please use the command su fly to switch to the regular user
  • For other systems, use the command su <your host username> to switch to the regular user
su <your host 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 an introduction on how to compile the firmware:

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

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

  • Among these, rm -rf ~/klipper/.config && rm -rf ~/klipper/out deletes previous compilation data and firmware.

  • make menuconfig is for compiling the firmware. After execution, the following interface should appear:

    Loading...

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

    Loading...

  • Navigate to the Micro-controller Architecture menu, then select Raspberry Pi RP2040/RP235x and press Enter.

    Loading...

  • Select Bootloader offset, choose: NO bootloader.

    Loading...

  • Select Communication interface, choose: UART0 on GPIO0/GPIO1.

    Loading...
  • Select GPIO pins to set at micro-controller startup, enter: !gpio5
warning

Please enter !gpio5 with the English input method enabled.

Loading...
  • Press the Q key. When Save configuration appears, press the Y key.
Loading...
  • The configuration should now be saved, and you should have exited back to the command line interface.
  • Enter the command below to start compilation. This will take some time.
make -j4
Loading...
  • Compilation is successful if the final output contains the following content.
  • Due to Klipper version differences, the appearance of out/klipper.uf2 indicates success. 
    Linking out/klipper.elf
    Creating uf2 file out/klipper.uf2

Enter Flashing Mode​

tip

The arrow points to the BOOT button.

  • With the tool board completely powered off, press and hold the BOOT button. Use a Type-C data cable with data transfer capability to connect the tool board to a USB port on your host computer. Release the BOOT button after a successful connection to the host is established.
    Loading...

Verify Entry into Flashing Mode​

Flash RS232 Firmware​

  • Please note that the current toolboard is in firmware burning mode and can only burn firmware with a .uf2 suffix.
  • Use the following command to burn the firmware to the toolboard.
cd && cd ~/klipper/
make flash FLASH_DEVICE=2e8a:0003
tip

If this is the first burn after writing the system with the host machine, you may see a prompt similar to the one circled in red below — partial red prompts are normal and not an error.

Loading...

Verify Firmware Startup​

  • If the firmware starts normally, the LED indicated in the image below will light up.
    Loading...
Loading...