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 check the USB-ID Retrieval section.
• If you have flashed the USB Bridge firmware, please check 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 mainboard has been flashed with the USB firmware.
• This tutorial is only applicable for Mainboard ID search, not for Toolboard ID search.
• Please confirm the mainboard is connected to the host computer's USB port via TYPEC.
• 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 Characteristics	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. It needs to be flashed with Klipper firmware before use.	/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 mainboard'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 documentation are examples. The actual ID for each mainboard is different. Please modify and fill in according to the ID you actually obtained.

Fill in the USB ID

• Find [mcu], then replace it.

Note

• Please replace in the configuration file:
• 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

• Must connect to the host via SSH, please use network login to connect to the host (such as Raspberry Pi and other devices).
• Before operation, ensure that 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 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 has already been configured for CAN.
• If you are using a Fly host, it is already configured for CAN by default, and the CAN baud rate is 1M.
• If you are using CAN for the first time, be sure to read the tutorial below first.
• CAN Configuration Tutorial

Search for CAN ID

• Search command for a regular host:

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

• Search command for a FLY host:

  python3 ~/klipper/scripts/canbus_query.py can0

  • After executing the search command, several situations may occur. Please troubleshoot and determine based on your situation:
    • If an ID appears and Application: at the end shows Klipper, it means this ID can be used directly.
    • If an ID appears and Application: at the end shows CANBOOT or Katapult, it means firmware flashing is required before it can be used.
    • If Total 0 uuids found appears, the following situations may apply:
      • There is an issue with the CAN network configuration.
      • The CAN baud rate is inconsistent. Please ensure the host 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 restart.
        Loading...

Enter the CAN ID into the configuration

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

• If Application: shows Canboot, it cannot be configured; you need to flash the Klipper firmware to proceed to the next step.

  Loading...
  dangerous

  Note: All IDs appearing in the document are examples. The actual ID of each mainboard is different. Please modify and fill in according to the ID you actually obtained.

For fluidd: {…} , click to enter, then you can find printer.cfg. Loading...

For mainsail: Machine, click to enter, then you can find printer.cfg. Loading...

• Below is a reference configuration:
  dangerous

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

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