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.

Notes

Important Notes

• You must connect to the host via SSH, use a network login method to connect to the host (such as a Raspberry Pi)
• Ensure the motherboard has been flashed with USB firmware before proceeding
• This tutorial is only applicable for motherboard ID search, not for toolboard ID search
• Make sure the motherboard is connected to the host's USB port via TYPEC
• To view the toolboard ID, please refer to the relevant tutorial under the corresponding product directory

Steps

Search for USB Device ID

• Run the following command to list all USB serial device IDs:

  ls /dev/serial/by-id/*

⚠️ Important: Unusable IDs

After executing the command, please pay attention to identifying and avoid using the following two types of IDs:

ID Feature	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 flash mode, Klipper firmware must be flashed before use.	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Result Explanation:

• Normal Case: The terminal will display an ID similar to the following (image below is just an example)
  Loading...
• Troubleshooting Abnormal Issues

Handling Multiple IDs

If multiple IDs appear, select the corresponding ID based on your motherboard's MCU model

Fill the USB ID into the Configuration

For fluidd: click {…} to find printer.cfg Loading...

For mainsail: click Machine to find printer.cfg Loading...

Note: All IDs shown in the document are examples. Each motherboard's ID is different. Modify based on the actual ID obtained.

Fill in the USB ID

• Find [mcu], then replace

Note

• Please replace the content in the configuration file:
• Do not configure canbus_uuid:

[mcu]
serial: <Replace this with the ID you just queried>

• Reference

For fluidd Loading...

For mainsail Loading...

• Click SAVE & RESTART in the top right corner. 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

  Preparation

  Important Prerequisites

  • Toolboard Status: Ensure the toolboard has been flashed with Klipper-can firmware or is in Katapult-can mode
  • Note: This guide is only for toolboard ID search, not applicable for motherboard ID search
  • Connection Requirements: The toolboard must be connected to one of the following devices:
    • UTOC module
    • A motherboard flashed with USB bridge CAN firmware
  • Final Connection: The above devices must be connected to the host computer

  CAN Network Configuration Requirements

  • Default Configuration: This guide assumes the host computer has already configured the CAN network
  • Fly Users: If using a Fly host computer running the Fly-FAST system, CAN is configured by default (rate 1Mbps)
  • First Time Use: Please read the following tutorial first: CAN Configuration Guide

  Connect to SSH

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

  Search for CAN ID

  • Standard host computer search command

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

  • FLY host computer search command

    python3 ~/klipper/scripts/canbus_query.py can0

  Search Results Explanation

  CANID

  • Note: The motherboard ID has already been configured in Klipper in previous documentation; under normal circumstances, the motherboard's CANID cannot be found
  • Quick verification method: If confirmation is needed, first disconnect the CAN connection cable between the motherboard and the toolboard, then re-execute the search
  • After executing the search command, the following situations may occur:

  Display Result	Status Description	Next Steps
  Application: Klipper	Device has been flashed with Klipper firmware	Can use this ID directly
  Application: CANBOOT or Katapult	Device is in Bootloader mode	Must flash Klipper firmware before use
  Total 0 uuids found	No devices found	Check the following issues: 1. Is the CAN network configured correctly 2. Are CAN rates consistent (default 1Mbps) 3. Is the ID already used in the configuration (disable, save, power cycle first)

  Loading...
  About Duplicate IDs

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

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

  Configure CAN Device ID

  1. Obtain Configuration File

  Depending on the web interface used, locate the printer.cfg configuration file:

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

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

  2. Add Device Configuration

  Add the toolboard configuration to printer.cfg:

  [mcu toolboard]
  canbus_uuid: <fill in the queried ID here>

  Configuration Explanation

  • toolboard is the toolboard name; modify it according to the actual situation
  • If it is a motherboard ID, the configuration section should be [mcu]
  • In normal configuration, the motherboard uses [mcu], and the toolboard uses [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 only; each motherboard's ID is different. Please modify and fill in based on the actual ID obtained.