Read and View Mainboard ID

Important Notes

• This tutorial is only applicable to the methods for reading and viewing the ID of a mainboard.
  If you are using a toolboard, please refer to the ID search tutorial for the corresponding product.
• If you are using a toolboard, you can directly click the button below to jump:
  Connect Toolboard
• If you have flashed the USB firmware, please refer to the USB ID Retrieval section.
• If you have flashed the USB Bridge firmware, please refer to the CAN ID Retrieval section.

• USB ID Retrieval
• CANBus UUID Retrieval

Precautions

Important Notes

• Must connect to the host computer via SSH, please use network login to connect to the host computer (such as Raspberry Pi and other devices).
• Before operation, ensure the motherboard has been flashed with the USB firmware.
• This tutorial is only applicable for Motherboard ID search, not for Toolboard ID search.
• Please confirm the motherboard is connected to the host computer's USB port using Type-C.
• To view the Toolboard ID, please refer to the relevant tutorial in the corresponding product directory.

Operation Steps

Search for USB Device ID

• Execute the following command to list all USB serial device IDs:

  ls /dev/serial/by-id/*

⚠️ Important Note: Unusable IDs

After executing the command, please identify and avoid using the following two types of IDs:

ID Characteristic	Reason Explanation	Example
usb-1a86_USB_Serial-if00-port0	This 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 katapult	Indicates the device is in bootloader mode, Klipper firmware must be flashed before it can be used.	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Execution Result Explanation:

• Normal Situation: The terminal will display an ID similar to the example below (the image is for illustration only).
  Loading...
• Troubleshooting for Abnormal Issues

Handling Multiple IDs

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

Fill the USB ID into the Configuration

For fluidd: {…}, click into it to find printer.cfg. Loading...

For mainsail: Machine, click into it to find printer.cfg. Loading...

Note: All IDs appearing in the document are examples. The actual ID for each motherboard is different. Please modify and fill in based on the ID you actually obtained.

Fill in the USB ID

• Find [mcu], then replace it.

Note

• Please replace in the configuration file:
• Please do not configure canbus_uuid:.

[mcu]
serial: <Replace here with the ID you just queried>

• Reference

Reference for fluidd Loading...

Reference for mainsail Loading...

• Click the SAVE & RESTART button in the upper right corner. After clicking, it will automatically save and restart Klipper.

Precautions

Important Notes

• You must connect to the host computer via SSH. Please use network login to connect to the host computer (e.g., Raspberry Pi or similar devices).
• Before proceeding, ensure the mainboard has been flashed with the USB Bridge CAN firmware.
• This tutorial applies only to searching for the Mainboard ID and is not applicable for searching the Toolboard ID.
• Please confirm that the host computer and the mainboard are correctly connected.
• To view the Toolboard ID, please refer to the relevant tutorial in the corresponding product directory.

CAN Precautions

• This tutorial assumes your host computer is already configured for CAN.
• If you are using a Fly host computer, it is preconfigured for CAN with a default baud rate of 1M.
• If this is your first time using CAN, be sure to read the tutorial below first.
• CAN Configuration Tutorial

Searching for CAN ID

• Search command for a standard host computer:

  ~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0

• Search command for a FLY host computer:

  python3 ~/klipper/scripts/canbus_query.py can0

  • After executing the search command, several outcomes are possible. Please troubleshoot and determine based on your situation:
    • If an ID appears and Application: at the end shows Klipper, this ID can be used directly.
    • If an ID appears and Application: at the end shows CANBOOT or Katapult, the firmware needs to be flashed before it can be used.
    • If Total 0 uuids found appears, the following situations are possible:
      • There is an issue with the CAN network configuration.
      • The CAN baud rate is inconsistent. Please ensure the host computer's CAN baud rate matches that of the mainboard, toolboard, etc.
      • If the corresponding ID is already configured in Klipper, you need to first disable the ID in the system configuration, then shut down, power off, and power on again.
        Loading...

Entering the CAN ID into the Configuration

• Copy the queried UUID and configure it in printer.cfg.

• If Application: shows Canboot, it cannot be configured directly. You need to flash the Klipper firmware to proceed.

  Loading...
  Danger

  Note: All IDs appearing in the documentation are examples. The actual ID for each mainboard is unique. Please modify and fill in the ID based on what you actually obtain.

For fluidd: Go to {…} and click in to find printer.cfg. Loading...

For mainsail: Go to Machine, click in to find printer.cfg. Loading...

• Reference configuration is provided below:
  Danger

  [mcu]
  canbus_uuid: <Replace here with the ID you just queried>

  • The mainboard ID must be configured as [mcu] plus canbus_uuid: plus the ID you searched for.
  • Do not configure serial:.
  Loading...
  • Click SAVE & RESTART in the upper right corner. After clicking, it will automatically save and restart Klipper.