Skip to main content

Important Notes

Precautions
  • This tutorial specifically covers the wiring and ID search for toolboards. The related steps do not apply to mainboards. Please note the distinction.
  • If you are not using a toolboard, please ignore this tutorial.

Toolboard ID Reading and Viewing

  • 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.
    • Important Note: This tutorial is only for searching for Toolboard IDs. It is not applicable for searching for Mainboard IDs.
    • Connection Requirement: The toolboard must be connected to one of the following devices:
      • A UTOC module
      • A mainboard flashed with USB-to-CAN Bridge firmware
    • Final Connection: The aforementioned device must be connected to the host computer.

    CAN Network Configuration Requirements​

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

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

    Search for CAN ID​

    • Search command for a standard host computer: 
      ~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0
    • Search command for a FLY host computer: 
      python3 ~/klipper/scripts/canbus_query.py can0

    Search Result Explanation​

    CANID
    • Important Note: The mainboard ID has already been configured in Klipper in previous documentation. Under normal circumstances, the mainboard's CANID cannot be found in the search.
    • Quick Verification Method: If confirmation is needed, first disconnect the CAN cable between the mainboard and the toolboard, then re-run the search.
    • After executing the search command, the following situations may occur:
    Result DisplayStatus DescriptionNext Steps
    Application: KlipperDevice is flashed with Klipper firmwareThis ID can be used directly.
    Application: CANBOOT or KatapultDevice is in Bootloader modeKlipper firmware needs to be flashed before use.
    Total 0 uuids foundNo devices foundPlease check the following issues:
    1. Is the CAN network configured correctly?
    2. Is the CAN rate consistent? (Default: 1Mbps)
    3. Is this ID already used in the configuration? (You 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 for it 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.

    Configure CAN Device ID​

    1. Obtain the Configuration File​

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

    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: <Enter the queried ID here>
    Configuration Note
    • toolboard is the name of the toolboard. Please modify it according to your actual situation.
    • For a mainboard ID, the configuration section should be [mcu].
    • In a normal configuration, the mainboard uses [mcu], and toolboards use [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. The actual ID for each mainboard/toolboard is different. Please modify and fill in based on the ID you actually obtain.

Loading...