Important Notes

Important Notes

• This tutorial specifically covers the wiring and ID search for tool boards. The related steps are not applicable to mainboards. Please note the distinction.
• If you are not using a tool board, please ignore this tutorial.

Tool Board ID Reading and Viewing

CANBus UUID Retrieval

• CAN Reference Wiring

  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.
  • Applicable Scope: This tutorial is only for Toolboard ID searching, not for Mainboard ID searching.
  • Connection Requirements: The toolboard must be connected to one of the following devices:
    • A UTOC module.
    • A mainboard flashed with USB Bridge CAN firmware.
  • Final Connection: The aforementioned device needs to be connected to the host computer.

  Hardware Connection and Termination Resistor Configuration

  Safety First

  • Complete Power Off: All wiring operations must be performed with the devices completely powered off.
  • Prevent Short Circuits: Please disconnect power to all devices before operation.

  Connection Specification Table

  Device Type	Termination Resistor Requirement	Configuration Method
  CAN Toolboard	Requires a 120Ω termination resistor	Enable via jumper cap or DIP switch
  Mainboard CAN Interface	Requires a 120Ω termination resistor	Enable via jumper cap or DIP switch
  UTOC Module	Has a built-in 120Ω resistor	No additional connection needed

  Configuration and Measurement Steps

  1. Hardware Configuration

     • Check if the 120Ω jumper cap or DIP switch near the mainboard's CAN interface is connected or turned on.
     • Check if the 120Ω jumper cap or DIP switch on the toolboard is connected or turned on.

  2. Resistance Measurement (with power off)

     • Measurement Points: Between CAN-H and CAN-L.
     • Tool: Multimeter.

  Resistance Value Troubleshooting Table

  Notes

  • Measurement must be performed with the power off.
  • If the measurement is around 140Ω, it may be due to CAN-H and CAN-L being swapped.

  Measured Value	Status	Possible Cause	Solution
  Around 60Ω	✅ Normal	Termination resistors correctly connected at both ends	Configuration complete
  Around 120Ω	❌ Abnormal	Line broken or not connected	Check all connections
  Around 40Ω	❌ Abnormal	Three ends have resistors connected	Remove the middle resistor

  Important Notes

  • UTOC Module: Has a built-in resistor. The mainboard does not need a termination resistor when connected to it.
  • Connection Scenarios:
    • Toolboard ↔ Mainboard (both ends need termination resistors).
    • Toolboard ↔ UTOC ↔ Host Computer (only the toolboard needs a termination resistor).
  • Troubleshooting Process:

    Measure resistance → 60Ω → Ready for use
           ↓
        Abnormal value → Check table above → Adjust and remeasure

  Hardware Checklist

  • All devices completely powered off.
  • Mainboard CAN interface termination resistor connected (except for UTOC).
  • Toolboard termination resistor connected.
  • Multimeter measures resistance ≈60Ω.
  • CAN-H and CAN-L wiring is correct and secure.
  Professional Advice

  Correct termination resistor configuration is crucial for CAN bus communication quality. Deviations in resistance values may lead to unstable communication or data loss.

  CAN Network Configuration Requirements

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

  Summary Process

  1. Hardware Preparation: Wire with power off, configure termination resistors, measure and confirm 60Ω.
  2. Network Confirmation: Ensure the host computer's CAN network is correctly configured.
  3. Connect to Host: Connect to the host computer via UTOC or a USB-bridged mainboard.
  4. Firmware Status: Confirm the toolboard is in Klipper-can or Katapult-can mode.
  5. Subsequent Operations: Proceed with ID search and configuration as per the following tutorials.

  At this point, your CAN toolboard hardware connection and network environment are ready. You can proceed with ID search and configuration operations.

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

  Search for Devices

  • Now that you have successfully logged into the host computer, you can enter lsusb to search for devices. You may encounter one of the following situations:
    • If entering lsusb prompts that the ls command is not found, you can install the required utility by entering the following command:

      sudo apt-get install usbutils

    • If there is no response after entering lsusb, this is a system issue and cannot be resolved here. You will need to change the system or use a known working system.
    • If information like that shown in the image below appears, please note that this is only a reference. You only need to confirm that 1d50:606f appears:
      Loading...
  • 1d50:606f is the device you will use in this instance.
  • If multiple 1d50:606f devices appear, one must be excluded, as multiple entries may affect subsequent flashing and firmware connection. For example, with FLY MINI PAD, it is recommended to use the onboard UTOC and avoid using other CAN bridges.
  • If the device does not appear, please check whether the data cable is properly connected and whether the correct firmware has been flashed.
  Note

  You can proceed to search for the CAN ID only when 1d50:606f appears.

  Search for CAN ID

  Fly-Armbian / Generic System

  Execute the following command to search for CAN device IDs:

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

  Fly-FAST System

  Execute the following command to search for CAN device IDs:

  python ~/klipper/scripts/canbus_query.py can0

  Search Result Explanation

  After executing the search command, the following situations may occur:

  Result Display	Status Description	Next Steps
  Application: Klipper	Device is flashed with Klipper firmware	Can use this ID directly
  Application: CANBOOT or Katapult	Device is in Bootloader mode	Needs to be flashed with Klipper firmware before use
  Total 0 uuids found	No devices found	Please check the following: 1. Is the CAN network configured correctly? 2. Is the CAN rate consistent? (Default 1Mbps) 3. Is the ID already used in the configuration? (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 again, please:

  1. Comment out the 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

  Find the printer.cfg configuration file based on the web interface you are using:

  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 in printer.cfg:

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

  Configuration Note

  • toolboard is the toolboard name, please modify according to your actual situation.
  • For a mainboard ID, the configuration section should be [mcu].
  • In a normal configuration, 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 the documentation are examples. The actual ID for each mainboard is different. Please modify and fill in according to the ID you actually obtained.