Important Notes

Important Notes

• This tutorial specifically covers the wiring and ID search for the Tool Board. The related steps are not applicable to the Main Board. Please distinguish between them.
• If you are not using a Tool Board, please ignore this tutorial.

Tool Board ID Reading and Viewing

• USB ID Retrieval
• CANBus UUID Retrieval

• Please prepare a data cable with data transfer capability. If the cable is particularly long, it is recommended to use a data cable with a ferrite core.
• Connect the Tool Board to the host computer via a USB data cable.

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.

• Before searching for the ID, connect the Tool Board to a UTOC or a Main Board flashed with bridge firmware using an XT30 data cable. The reference wiring diagram is below.

• Please check if the DIP switch is set to the correct position.

  Loading...

• Please ensure that the resistance between CAN H and CAN L, measured with a multimeter while powered off, is around 60Ω. If it is 120Ω, you need to connect a 120Ω jumper. If it is around 40Ω, you need to remove the jumper.

  Loading...

  Complete Guide to CAN Toolboard Setup

  Preparations

  Important Prerequisites

  • Toolboard Status: Ensure the toolboard is flashed with Klipper-can firmware or is in Katapult-can mode.
  • Important Note: This tutorial is only for searching Toolboard IDs, not for Mainboard IDs.
  • Connection Requirements: The toolboard must be connected to one of the following devices:
    • A UTOC module.
    • A mainboard flashed with USB Bridge CAN firmware.
  • Final Connection: The above device must be connected to the host computer.

  CAN Network Configuration Requirements

  • Default Configuration: This tutorial assumes the host computer's CAN network is already configured.
  • Fly Users: If using a Fly host computer running the Fly-FAST system, CAN is configured by default (rate: 1Mbps).
  • First-time Users: Please read the tutorial below first: CAN Configuration Tutorial

  Connect via SSH

  • Log in to SSH over the network (do not use serial port login).
  • Ensure the host computer is properly connected to the CAN network device.

  Search for CAN ID

  • Search command for standard host computers:

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

  • Search command for FLY host computers:

    python3 ~/klipper/scripts/canbus_query.py can0

  Search Result Explanation

  CANID

  • Important Note: The mainboard ID has already been configured in Klipper in previous documentation. Under normal circumstances, the mainboard's CANID cannot be found via search.
  • Quick Verification Method: If confirmation is needed, first disconnect the CAN cable between the mainboard and the toolboard, then re-run the search.
  • After executing the search command, the following situations may occur:

  Result Display	Status Description	Next Steps
  Application: Klipper	Device is flashed with Klipper firmware.	This ID can be used directly.
  Application: CANBOOT or Katapult	Device is in Bootloader mode.	Needs to be flashed with Klipper firmware before use.
  Total 0 uuids found	No devices found.	Please check the following: 1. Is the CAN network configured correctly? 2. Is the CAN rate consistent? (Default: 1Mbps) 3. Is this ID already used in the configuration? (Need to comment it out, save, power off, and restart.)

  Loading...
  About Duplicate IDs

  If a device ID is already configured in printer.cfg, it will not appear in the search results. To search for it again, please:

  1. Comment out that device ID in the configuration file.
  2. Save the configuration and restart Klipper.
  3. Power off and restart all devices.

  Configure CAN Device ID

  1. Locate the Configuration File

  Find the printer.cfg configuration file based on the web interface you are using:

  Fluidd Click the {...} icon in the left navigation bar, then find printer.cfg. Loading...

  Mainsail Click Machine in the top navigation bar, then find printer.cfg. Loading...

  2. Add Device Configuration

  Add the toolboard configuration to printer.cfg:

  [mcu toolboard]
  canbus_uuid: <Enter the ID found here>

  Configuration Notes

  • toolboard is the toolboard name; please modify it according to your actual situation.
  • For a mainboard ID, the configuration section should be [mcu].
  • In a normal configuration, the mainboard uses [mcu], and toolboards use [mcu toolboard].

  3. Save and Restart

  1. Click the SAVE & RESTART button in the top right corner.
  2. The system will automatically save the configuration and restart Klipper.
  Loading...
  Note

  All IDs appearing in this document are examples. The actual ID for each mainboard is different. Please modify and fill in the ID based on what you actually obtain.