Important Notes

Precautions

• This tutorial focuses specifically on the operation and use of the toolboard. The relevant steps do not apply to the main board; please be aware of this difference.
• If you do not use the toolboard, please ignore this tutorial.

Reading and Viewing Toolboard IDs

• Obtain USB ID
• Obtain CANBus UUID

Precautions

Important Prerequisite

Before starting to search for the toolboard ID, please ensure that all the following conditions are met:

• Firmware Preparation: The toolboard has been flashed with USB firmware, or is currently in USB flashing mode.
• Clear Objective: This tutorial is only for searching for the toolboard ID, not applicable for the motherboard ID.
• Hardware Connection: The toolboard is correctly connected to the USB-A port of the upper computer via USB.
• Login Method: Please log in to the upper computer via network SSH to operate, do not use serial port login.

Search for USB ID

ls /dev/serial/by-id/*

• Normal Condition: The terminal will display an ID similar to the one below (the image below is just an example)
  Loading...

• If no ID appears after entering the command below, but the device is present with lsusb, please replace the upper computer or its operating system

Note

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 on it to find printer.cfg Loading...

For mainsail: Machine, click on it to find printer.cfg Loading...

Danger

Note: All IDs appearing in the document are examples. The actual ID for each motherboard will be different. Please modify and fill in the ID based on the one you actually obtain.

Fill in the Toolboard USB ID

• Below is a reference configuration

  Note

  • In the configuration below, toolboard refers to the name of the toolboard. If it is another name, please replace it with the corresponding name.
  Danger

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

  • To add the toolboard ID, it must be [mcu toolboard] followed by serial: and then the toolboard ID you found.
  • Below is a reference configuration
  • Please note that this tutorial is for searching and configuring the toolboard ID. Under normal circumstances, the motherboard should already be connected.
  • Also, the motherboard must be [mcu], and the toolboard must be [mcu toolboard]

  Reference for fluidd Loading...

  Reference for mainsail Loading...

  • Click SAVE & RESTART in the upper right corner. After clicking, it will automatically save and restart klipper.

• CAN Reference Wiring

  Loading...

  CANBus UUID Acquisition

  Preparation

  Important Prerequisites

  • Toolboard Status: Ensure the toolboard has been 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 Requirement: The toolboard must be connected to one of the following devices:
    • UTOC module
    • A mainboard flashed with USB Bridge CAN firmware
  • Power Requirement: Some mainboards cannot detect the toolboard when powered only through USB. Completely power off the machine first, then connect a supported 12V-24V low-voltage supply according to the mainboard documentation. Power it on again before searching for the toolboard ID
  • Final Connection: The above devices need to be connected to the host machine

  CAN Network Configuration Requirements

  • Default Configuration: This tutorial assumes the host machine has already configured the CAN network
  • Fly Users: If using a Fly host running the Fly-FAST system, CAN is configured by default (1Mbps rate)
  • First-time Use: Please be sure to read the tutorial below first: CAN Configuration Tutorial

  Connecting via SSH

  • Log in to SSH over the network (do not use serial login)
  • Ensure the host machine is properly connected to the CAN network devices

  Searching for CAN ID

  • Search command for standard host machines

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

  • Search command for FLY host machines

    python3 ~/klipper/scripts/canbus_query.py can0

  Explanation of Search Results

  CANID

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

  Result Displayed	Status Description	Next Steps
  Application: Klipper	Device has Klipper firmware flashed	The ID can be used directly
  Application: CANBOOT or Katapult	Device is in Bootloader mode	Klipper firmware must be flashed before use
  Total 0 uuids found	No devices found	Please check the following issues: 1. Whether the CAN network configuration is correct 2. Whether the CAN baud rate is consistent (default 1Mbps) 3. Whether this ID is already in use in the configuration (if so, comment it out, save, power off, and restart)

  Loading...
  Regarding Duplicate IDs

  If a device ID is already configured in printer.cfg, it will not appear in the search results. To search 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

  Configuring the CAN Device ID

  1. Locate the Configuration File

  Based on the web interface being used, find the printer.cfg configuration file:

  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: <fill in the queried ID here>

  Configuration Notes

  • toolboard is the name of the toolboard; modify it according to the actual situation
  • For a mainboard ID, the configuration section should be [mcu]
  • In normal configurations, the mainboard uses [mcu], and the toolboard uses [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 documentation are examples only; the actual IDs differ from board to board. Please modify and fill in the ID based on what you actually obtain.