Reading and Viewing Mainboard ID

Important Notes

• This tutorial is only applicable to the method of reading and viewing the mainboard ID.
  If you are using a tool board, please refer to the ID search tutorial for the corresponding product.
• If you are using a tool board, you can click the button below to jump directly:
  Connect Tool Board
• If you have flashed USB firmware, please refer to the USB-ID Acquisition section.
• If you have flashed USB bridge firmware, please refer to the CAN-ID Acquisition section.

• USB ID Acquisition
• CANBus UUID Acquisition

Obtaining the Mainboard USB ID

Important Notes

Power Off Before Operation

When connecting or re-plugging the mainboard USB cable, please completely shut down the printer and disconnect the power supply first. Do not plug or unplug the cable while the printer is powered on.

Scope of Use

• You must log in to the host machine via SSH to execute the search commands.
• Before proceeding, please confirm that the mainboard has been flashed with USB firmware and is connected to the host machine's USB port via a Type-C data cable.
• This tutorial is only for searching the mainboard USB ID and is not applicable for searching toolhead board IDs.
• For toolhead board devices, please refer to the USB or CAN ID acquisition tutorial in the corresponding product documentation.

Procedure

Searching for the USB Device ID

Log in to the host machine via SSH and run the following command to list all USB serial device IDs:

ls /dev/serial/by-id/*

Unusable IDs

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

ID Characteristic	Reason	Example
usb-1a86_USB_Serial-if00-port0	Default name for generic serial chips like CH340; cannot be used as the Klipper mainboard connection address	/dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
Contains katapult	The device is in Katapult flashing mode; Klipper firmware needs to be flashed first	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Search Results

Under normal circumstances, the terminal will display a device path similar to the image below. The ID in the image serves only as a format example.

Loading...

No Available ID Found: Refer to the Firmware and Connection Troubleshooting Guide

Multiple IDs Detected

If the command returns multiple available IDs, please identify the complete device path corresponding to your mainboard by checking the MCU model and comparing the device list before and after plugging/unplugging.

Filling the USB ID into the Configuration

Open printer.cfg in Fluidd or Mainsail:

Fluidd: Click the {…} icon on the left, then open printer.cfg. Loading...

Mainsail: Click "Machine" on the left, then open printer.cfg. Loading...

Use the Actual Search Result for the ID

All device paths in this document are examples. The USB ID of each mainboard may differ. Please copy the exact path returned by the SSH command.

Locate the [mcu] configuration section and change the serial parameter to the complete device path you obtained:

[mcu]
serial: /dev/serial/by-id/usb-Klipper_xxxxxxxxxxxx

When using USB firmware, you should configure serial. Do not fill in canbus_uuid in the same [mcu] section simultaneously.

Refer to the image below for the configuration location:

Fluidd Configuration Example Loading...

Mainsail Configuration Example Loading...

After modification, click SAVE & RESTART in the top right corner to save the configuration 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