Skip to main content

Important Notes

Important Notes
  • This tutorial specifically covers the wiring and ID search for the Toolboard. The related steps are not applicable to the Mainboard. Please distinguish between them.
  • If you are not using a Toolboard, please ignore this tutorial.

Toolboard ID Reading and Viewing

  • Prepare a data cable with data transfer functionality. If the cable is particularly long, it is recommended to use a data cable with a ferrite core.
  • Connect the Toolboard to the host computer via the USB data cable.

Notes

Important Notes
  • You must connect to the host via SSH, use a network login method to connect to the host (such as a Raspberry Pi)
  • Ensure the motherboard has been flashed with USB firmware before proceeding
  • This tutorial is only applicable for motherboard ID search, not for toolboard ID search
  • Make sure the motherboard is connected to the host's USB port via TYPEC
  • To view the toolboard ID, please refer to the relevant tutorial under the corresponding product directory

Steps

Search for USB Device ID

  • Run the following command to list all USB serial device IDs:
    ls /dev/serial/by-id/*

⚠️ Important: Unusable IDs

After executing the command, please pay attention to identifying and avoid using the following two types of IDs:

ID FeatureReason ExplanationExample
usb-1a86_USB_Serial-if00-port0This is the default name for generic serial chips like CH340, cannot be used for configuration./dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
Contains katapultIndicates the device is in flash mode, Klipper firmware must be flashed before use./dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Result Explanation:

Handling Multiple IDs

If multiple IDs appear, select the corresponding ID based on your motherboard's MCU model

Fill the USB ID into the Configuration

  • For fluidd: click {…} to find printer.cfg
Loading...
  • For mainsail: click Machine to find printer.cfg
Loading...

Note: All IDs shown in the document are examples. Each motherboard's ID is different. Modify based on the actual ID obtained.

Fill in the USB ID

  • Find [mcu], then replace
Note
  • Please replace the content in the configuration file:
  • Do not configure canbus_uuid:
[mcu]
serial: <Replace this with the ID you just queried>
  • Reference
  • For fluidd
Loading...
  • For mainsail
Loading...
  • Click SAVE & RESTART in the top right corner. It will automatically save and restart Klipper.
Loading...