Important Notes

Important Notes

• This tutorial specifically covers the operation and usage of the Tool Board. The related steps are not applicable to the Main Board. Please distinguish between them carefully.
• If you are not using a Tool Board, please ignore this tutorial.

Tool Board ID Reading and Viewing

• USB ID Retrieval
• CANBus UUID Retrieval

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...

  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.