Mainboard ID Reading and Viewing

Important Notes

• This tutorial is only applicable to the mainboard ID reading and viewing methods.
  If you are using a toolboard, please refer to the corresponding product's ID search tutorial.
• 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

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 Feature	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 flash mode, Klipper firmware must be flashed before use.	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Result Explanation:

• Normal Case: The terminal will display an ID similar to the following (image below is just an example)
  Loading...
• Troubleshooting Abnormal Issues

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.

Notes

Important Notes

• Must connect to the host via SSH. Please use network login to connect to the host (Raspberry Pi, etc.)
• Before operation, ensure the mainboard has been flashed with the USB Bridge CAN firmware
• This tutorial is only applicable for mainboard ID search, not for toolboard ID search
• Please confirm that the host and mainboard are correctly connected
• To view the toolboard ID, please refer to the relevant tutorial under the corresponding product directory

CAN Notes

• This tutorial assumes that your host has already been configured for CAN
• If you are using a Fly host, it is assumed that CAN is already configured with a rate of 1M
• If this is your first time using CAN, please be sure to read the tutorial below first
• CAN Configuration Tutorial

Search for CAN ID

• Standard host search command

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

• FLY host search command

  python3 ~/klipper/scripts/canbus_query.py can0

  • After executing the search command, several situations may occur. Please troubleshoot and determine accordingly based on your situation
    • If an ID appears and the Application: field at the end displays Klipper, this ID can be used directly
    • If an ID appears and the Application: field at the end displays CANBOOT or Katapult, flashing firmware is required before use
    • If Total 0 uuids found appears, the following situations may apply
      • CAN network configuration is incorrect
      • CAN rate mismatch. Ensure the host CAN rate is consistent with the mainboard, toolboard, etc.
      • If the corresponding ID has already been configured in Klipper, you need to first block the ID in the system configuration, then shut down, disconnect power, and reboot
        Loading...

Enter the CAN ID into the Configuration

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

• If Application: displays Canboot, it cannot be configured in the configuration file. You need to flash the Klipper firmware before proceeding

  Loading...
  Danger

  Note: All IDs appearing in the documentation are examples. Actual IDs for each mainboard are different. Please modify and fill in based on the actual ID obtained.

In fluidd, it is {…}. Click to enter and find printer.cfg Loading...

In mainsail, it is Machine. Click to enter and find printer.cfg Loading...

• Below is a reference configuration
  Danger

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

  • The mainboard ID must be [mcu] followed by canbus_uuid: and the ID you searched for
  • Do not configure serial:
  Loading...
  • Click SAVE & RESTART in the upper right corner. It will automatically save and restart klipper