Important Notes

Important Points

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

Toolboard ID Reading and Viewing

• USB ID Acquisition
• CANBus UUID Acquisition

• Please prepare a data cable with data transfer functionality. If the cable is particularly long, it is recommended to use a data cable with a ferrite core.
• Connect the toolboard 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 (e.g., Raspberry Pi).
• Before proceeding, ensure the mainboard has been flashed with the USB firmware.
• This tutorial is only applicable for Mainboard ID lookup, not for Toolboard ID lookup.
• Confirm the mainboard is connected to the host computer's USB port via Type-C.
• To look up the Toolboard ID, please refer to the relevant tutorial in the corresponding product directory.

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	Example
usb-1a86_USB_Serial-if00-port0	This is the default name for generic serial chips like CH340 and 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 must be flashed with Klipper firmware before use.	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Execution Result Explanation:

• Normal Case: 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.

Enter 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 this document are examples. The actual ID for each mainboard is different. Please modify and enter based on the ID you actually obtained.

Enter the USB ID

• Locate [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 top right corner. After clicking, Klipper will automatically save and restart.

• Before searching for the ID, connect the toolboard to a UTOC or a mainboard flashed with bridge firmware using an XT30 data cable. Below is a reference wiring diagram.

• Please check if the DIP switches are set to the correct positions.

  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 for Toolboard IDs. It is not applicable for searching for Mainboard IDs.
  • Connection Requirement: The toolboard must be connected to one of the following devices:
    • A UTOC module
    • A mainboard flashed with USB-to-CAN Bridge firmware
  • Final Connection: The aforementioned device must be connected to the host computer.

  CAN Network Configuration Requirements

  • Default Configuration: This tutorial assumes the CAN network is already configured on the host computer.
  • Fly Users: If using a Fly host computer running the Fly-FAST system, CAN is configured by default (rate: 1Mbps).
  • First-Time Users: Please be sure to 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 a standard 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

  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 in the 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	Klipper firmware needs to be flashed before use.
  Total 0 uuids found	No devices found	Please check the following issues: 1. Is the CAN network configured correctly? 2. Is the CAN rate consistent? (Default: 1Mbps) 3. Is this ID already used in the configuration? (You 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. Obtain the Configuration File

  Locate 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 queried ID here>

  Configuration Note

  • toolboard is the name of the toolboard. 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 upper 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/toolboard is different. Please modify and fill in based on the ID you actually obtain.