Skip to main content

Important Notes

Important Points
  • This tutorial specifically covers the wiring and ID search for the tool board. The related steps are not applicable to the mainboard. Please distinguish between them.
  • If you are not using a tool board, please ignore this tutorial.

Tool Board ID Reading and Viewing

  • Please note that the tool board's power cable is not connected to the CAN port; it is connected to the 12V-24V power line.
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 ResultStatus DescriptionNext Steps
Application: KlipperDevice has been flashed with Klipper firmwareCan use this ID directly
Application: CANBOOT or KatapultDevice is in Bootloader modeMust flash Klipper firmware before use
Total 0 uuids foundNo devices foundCheck 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.

Loading...