Skip to main content

Important Notes

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

Toolboard ID Reading and Viewing

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

    CANBus UUID Acquisition​

    Preparation​

    Important Prerequisites
    • Toolboard Status: Ensure the toolboard has been flashed with Klipper-can firmware or is in Katapult-can mode
    • Important Note: This tutorial is only for searching toolboard IDs, not for mainboard IDs
    • Connection Requirement: The toolboard must be connected to one of the following devices:
      • UTOC module
      • A mainboard flashed with USB Bridge CAN firmware
    • Final Connection: The above devices need to be connected to the host machine

    CAN Network Configuration Requirements​

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

    Connecting via SSH​

    • Log in to SSH over the network (do not use serial login)
    • Ensure the host machine is properly connected to the CAN network devices

    Searching for CAN ID​

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

    Explanation of Search Results​

    CANID
    • Note: The mainboard ID has already been configured into Klipper in previous documentation, so the mainboard's CANID cannot normally be found during a search
    • Quick Verification Method: If confirmation is needed, first disconnect the CAN connection cable between the mainboard and the toolboard, then re-run the search
    • After executing the search command, the following situations may occur:
    Result DisplayedStatus DescriptionNext Steps
    Application: KlipperDevice has Klipper firmware flashedThe ID can be used directly
    Application: CANBOOT or KatapultDevice is in Bootloader modeKlipper firmware must be flashed before use
    Total 0 uuids foundNo devices foundPlease check the following issues:
    1. Whether the CAN network configuration is correct
    2. Whether the CAN baud rate is consistent (default 1Mbps)
    3. Whether this ID is already in use in the configuration (if so, comment it out, save, power off, and restart)
    Loading...
    Regarding 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 that device ID in the configuration file
    2. Save the configuration and restart Klipper
    3. Power off and restart all devices

    Configuring the CAN Device ID​

    1. Locate the Configuration File​

    Based on the web interface being used, find the printer.cfg configuration file:

    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: <fill in the queried ID here>
    Configuration Notes
    • toolboard is the name of the toolboard; modify it according to the actual situation
    • For a mainboard ID, the configuration section should be [mcu]
    • In normal configurations, 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 this documentation are examples only; the actual IDs differ from board to board. Please modify and fill in the ID based on what you actually obtain.

Loading...