Important Notes

Important Points

• 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.
• If you are not using a Toolboard, please ignore this tutorial.

Toolboard ID Reading and Viewing

• USB ID Acquisition
• CANBus UUID Acquisition
• RS232 Usage Method

USB Connection Method

Supported Devices

Device Type	Connection Method	Requirements / Prerequisites
Toolboard	Connect to the USB-A port of the D8 Mainboard	Requires flashing USB Communication Firmware
Extended Mainboard	Connect to the USB-A port of the D8 Mainboard	Requires flashing USB Communication Firmware
USB Camera	Connect to the USB-A port of the D8 Mainboard	Must be a driverless plug-and-play type
USB Flash Drive	Connect to the USB-A port of the D8 Mainboard	Recommended to format with FAT32 file system

Loading...

Precautions

Important Prerequisites

Before starting to search for the toolboard ID, ensure all of the following conditions are met:

• Firmware Preparation: The toolboard has been flashed with the USB firmware or is currently in USB bootloader mode.
• Clear Objective: This tutorial is only for searching the toolboard ID, not applicable to the mainboard ID.
• Hardware Connection: The toolboard is correctly connected to the host computer's USB-A port via USB.
• Login Method: Please log in to the host computer via SSH over the network to perform operations, do not use serial port login.

Searching for USB ID

ls /dev/serial/by-id/*

• Normal Situation: The terminal will display an ID similar to the example below (the image below is for illustration only).
  Loading...

• If no ID appears after entering the command, but lsusb shows the device, please try a different host computer or a different host computer operating system.

Note

If multiple IDs appear, please select the ID corresponding to your mainboard's MCU model.

Enter the USB ID into the Configuration

For fluidd: {…}, click into it to find printer.cfg. Loading...

For mainsail: Machine, click into it to find printer.cfg. Loading...

Danger

Note: All IDs appearing in the documentation are examples. The actual ID for each mainboard is different. Please modify and fill in based on the ID you actually obtained.

Filling in the Toolboard USB ID

• The configuration below is for reference.

  Note

  • toolboard in the configuration below refers to the toolboard name. If it has a different name, please replace it with the corresponding name.
  Danger

  [mcu toolboard]
  serial: <Replace this with the ID you just queried>

  • Adding the toolboard ID must be [mcu toolboard] followed by serial: and then the toolboard ID you searched for.
  • The configuration below is for reference.
  • Please note this tutorial is for toolboard ID search and configuration. Under normal circumstances, it should already be correctly connected to the mainboard.
  • The mainboard must be [mcu], and the toolboard is [mcu toolboard].

  Reference for fluidd Loading...

  Reference for mainsail Loading...

  • Click the SAVE & RESTART button in the top right corner. After clicking, Klipper will automatically save and restart.

• CAN Reference Wiring
• Termination Resistor Configuration Check:

  Device	Configuration Method	Target State
  Mainboard	Locate the jumper socket or DIP switch labeled 120Ω	Place jumper cap or switch to ON
  Toolboard	Locate the jumper socket or DIP switch labeled 120Ω	Place jumper cap or switch to ON

Purpose: This resistor is crucial for ensuring stable CAN bus signals and preventing communication errors.

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 Toolboard IDs, not for Mainboard IDs.
• 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 above device must be connected to the host computer.

CAN Network Configuration Requirements

• Default Configuration: This tutorial assumes the host computer's CAN network is already configured.
• Fly Users: If using a Fly host computer 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 computer is properly connected to the CAN network device.

Search for CAN ID

• Search command for standard host computers:

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

• Search command for FLY host computers:

  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 via 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 Display	Status Description	Next Steps
Application: Klipper	Device is flashed with Klipper firmware.	This ID can be used 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 this 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 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. Locate 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, 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 ID found here>

Configuration Notes

• toolboard is the toolboard name; 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 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 mainboard is different. Please modify and fill in the ID based on what you actually obtain.

• RS232 Reference Wiring

Loading...

Searching for the RS232 ID of the Toolboard

Important Notes

Important Preparations

1. Firmware Requirement:
   The toolboard must be flashed with the RS232 firmware; otherwise, communication will not be possible.
2. Mandatory Common Ground:
   ⚠️ Before connecting the toolboard, ensure its GND is connected to the mainboard's GND (using the same 24V/12V power supply will achieve this).

RS232 Notes

• Only the D8, D8PRO, and C8P mainboards support the RS232 interface. Other mainboards do not support RS232.
• For unsupported mainboards, use G2T or UTOR for connection.

Searching for the RS232 ID

1. Open a browser, enter the host's IP address in the address bar (e.g., if the host IP is 192.168.101.179, type it and press Enter).

Loading...

2. Open the host's WEB interface. In the left sidebar configuration options, find:

For fluidd: {…}, click to enter, then find printer.cfg. Loading...

For mainsail: Machine, click to enter, then find printer.cfg. Loading...

3. Click printer.cfg, then click DEVICES in the top right corner.

Loading...

Loading...

4. Click SERIAL, then refresh.

Refreshing in fluidd. Loading...

Refreshing in mainsail. Loading...

5. Copy the ID. Click the indicated arrow to copy.

In fluidd, check if ch341-uart exists, then click Path_by_hardware. This is the RS232_ID. Loading...

In mainsail, check if CH341-UART exists, then click Path_by_hardware. This is the RS232_ID. Loading...

Note

• When connecting the toolboard using UTOR, two RS232_IDs often appear. Try each one.

Configuring the Toolboard RS232 ID

• Below is a reference configuration.

  Note

  • In the configuration below, toolboard refers to the toolboard name. If it has a different name, replace it accordingly.
  Danger

  [mcu toolboard]
  serial: <Replace here with the ID you just queried>
  baud: 250000
  restart_method: command

  • When adding the toolboard ID, it must be [mcu toolboard] followed by serial: and then the toolboard ID you found.
  • The following is a reference configuration.
  • Please note this tutorial is for toolboard ID search and configuration, assuming it is already properly connected to the mainboard.
  • The mainboard is always [mcu], and the toolboard is [mcu toolboard].
  • Click SAVE & RESTART in the top right corner. This will automatically save and restart Klipper.

Danger

Note: All IDs appearing in this document are examples. The actual ID for each mainboard is different. Please use the ID you actually obtained. ::