Skip to main content

Important Notes

Precautions
  • 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

  • CAN Reference Wiring
    Loading...
    • The 120Ω jumper needs to be connected.
    Loading...

    Complete Guide to CAN Tool Board Setup​

    Preparations​

    Important Prerequisites
    • Tool Board Status: Ensure the tool board is flashed with Klipper-can firmware or is in Katapult-can mode.
    • Important Note: This tutorial is only for searching Tool Board IDs, not for Main Board IDs.
    • Connection Requirements: The tool board must be connected to one of the following devices:
      • UTOC module
      • A main board flashed with USB Bridge CAN firmware.
    • Final Connection: The above device must be connected to the host machine.

    CAN Network Configuration Requirements​

    • Default Configuration: This tutorial assumes the CAN network is already configured on the host machine.
    • Fly Users: If using a Fly host machine running the Fly-FAST system, CAN is configured by default (rate 1Mbps).
    • First-time Users: Please 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 machine is properly connected to the CAN network device.

    Search for CAN ID​

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

    Search Result Explanation​

    CANID
    • Important Note: The main board ID has already been configured in Klipper in previous documentation. Under normal circumstances, the main board's CANID cannot be found via search.
    • Quick Verification Method: If confirmation is needed, first disconnect the CAN cable between the main board and the tool board, then re-execute 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 modeNeeds to be flashed with Klipper firmware before use.
    Total 0 uuids foundNo devices foundPlease check the following:
    1. Is the CAN network configured correctly?
    2. Is the CAN rate consistent? (Default 1Mbps)
    3. Has this ID already been 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 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​

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

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

Loading...