Mainboard ID Reading and Viewing

Note

• This tutorial is about methods for reading and viewing the mainboard ID. For toolboards, please refer to the corresponding product's ID search tutorial.
• If you are using a toolboard, please click the button below to jump to the relevant page.
• Connect Toolboard

• 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 proceeding, ensure the mainboard has been flashed with the USB firmware.
• This tutorial is only applicable for mainboard ID search, not for tool board ID search.
• Please confirm the host computer and the mainboard are correctly connected.
• To view the tool board ID, please refer to the relevant tutorial in the corresponding product directory.

Operation Steps

Search for USB Device ID

Execute the following command to search for the USB device ID:

ls /dev/serial/by-id/*

Explanation of Execution Results:

• Normal Situation: The terminal will display a blue ID similar to the example below (the image below is for illustration only).
  Loading...
• No ID Displayed: If no ID is displayed after executing the command, but the lsusb command can detect the device, there may be several possibilities:

1. System issue.
2. Incorrect command used; the USB ID search method may not find other firmware.

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 to enter and find printer.cfg. Loading...

For mainsail: Machine, click to enter and find printer.cfg. Loading...

Note: All IDs appearing in the document are examples. The actual ID for each mainboard is different. Please modify and fill in according to the ID 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, Klipper will automatically save and restart.

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 that the mainboard has been flashed with the USB Bridge CAN firmware.
• This tutorial is only applicable to mainboard ID search and not to toolboard ID search.
• 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 already configured for CAN by default, and the CAN 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 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, there will be several situations. Please troubleshoot and judge 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 needs to be flashed before it can be used.
    • If Total 0 uuids found appears, there are several possible situations:
      • There is an issue with the CAN network configuration.
      • The CAN rate is inconsistent. Please ensure the host computer's CAN 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...

Fill 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 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 actual obtained ID.

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.