Important Notes

Precautions

This tutorial specifically covers the wiring and ID search for the Tool Board. The related steps are not applicable to the Main Board. Please distinguish between them.
If you are not using a Tool Board, please ignore this tutorial.

Tool Board ID Reading and Viewing

USB ID Acquisition
CANBus UUID Acquisition
RS232 Usage Method

Please prepare a data cable with data transmission capability. If the cable is particularly long, it is recommended to use a data cable with a ferrite core.
Connect the Tool Board to the host computer via a USB data cable.

Precautions

Important Notes

Must connect to the host computer via SSH. Please use network login to connect to the host computer (e.g., Raspberry Pi).
Before proceeding, ensure the mainboard has been flashed with the USB firmware.
This tutorial is only applicable for Mainboard ID lookup, not for Toolboard ID lookup.
Confirm the mainboard is connected to the host computer's USB port via Type-C.
To look up the Toolboard ID, please refer to the relevant tutorial in the corresponding product directory.

Steps

Search for USB Device ID

Execute the following command to list all USB serial device IDs:
```
ls /dev/serial/by-id/*
```

⚠️ Important Note: Unusable IDs

After executing the command, please identify and avoid using the following two types of IDs:

ID Characteristics	Reason	Example
`usb-1a86_USB_Serial-if00-port0`	This is the default name for generic serial chips like CH340 and cannot be used for configuration.	/dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
Contains `katapult`	Indicates the device is in bootloader mode. It must be flashed with Klipper firmware before use.	/dev/serial/by-id/usb-katapult_xxxxxxxxxxxx

Execution Result Explanation:

Normal Case: The terminal will display an ID similar to the example below (the image is for illustration only).
Loading...
Troubleshooting for Abnormal Issues

Handling Multiple IDs

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

Enter the USB ID into the Configuration

For fluidd: {…}. Click into it to find printer.cfg.

For mainsail: Machine. Click into it to find printer.cfg.

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

Enter the USB ID

Locate [mcu], then replace it.

Note

Please replace in the configuration file:
Do not configure canbus_uuid:.

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

Reference

Reference for fluidd

Reference for mainsail

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

Before searching for the ID, connect the Tool Board to a UTOC or a Main Board flashed with bridge firmware using an XT30 data cable. The reference wiring diagram is below.
Please check if the DIP switch is set to the correct position.

Loading...

Ensure that the resistance between CAN H and CAN L, measured with a multimeter while powered off, is around 60Ω. If it is 120Ω, you need to connect a 120Ω jumper. If it is around 40Ω, you need to remove the jumper.

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 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	Klipper firmware needs to be flashed before use.
`Total 0 uuids found`	No devices found	Please 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.)

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:

Comment out that device ID in the configuration file.
Save the configuration and restart Klipper.
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.

Mainsail
Click Machine in the top navigation bar, then find printer.cfg.

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

Click the SAVE & RESTART button in the upper right corner.
The system will automatically save the configuration and restart Klipper.

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.

Before searching for the ID, connect the Tool Board to a UTOR or G2T using an XT30 data cable. The reference wiring diagram is below.
Please check if the DIP switch is set to the correct position.

Searching for the RS232 ID of the Toolboard

Precautions

Important Preparations

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

RS232 Notes

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

Searching for the RS232 ID

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

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

For fluidd: {…}. Click to find printer.cfg.

For mainsail: Machine. Click to find printer.cfg.

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

Click SERIAL, then refresh.

Refreshing in fluidd.

Refreshing in mainsail.

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.

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

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.
dangerous
[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.
- Below is the reference configuration.
- Please note this tutorial is for toolboard ID search and configuration. Normally, the toolboard should already be 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.

dangerous

Tool Board ID Reading and Viewing

Precautions​

Steps​

Search for USB Device ID​

⚠️ Important Note: Unusable IDs​

Execution Result Explanation:​

Enter the USB ID into the Configuration​

Enter the USB ID​

Complete Guide to CAN Toolboard Setup​

Preparations​

CAN Network Configuration Requirements​

Connect via SSH​

Search for CAN ID​

Search Result Explanation​

Configure CAN Device ID​

1. Obtain the Configuration File​

2. Add Device Configuration​

3. Save and Restart​

Searching for the RS232 ID of the Toolboard​

Precautions​

RS232 Notes​

Searching for the RS232 ID​

Configuring the Toolboard RS232 ID​

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

Precautions

Steps

Search for USB Device ID

⚠️ Important Note: Unusable IDs

Execution Result Explanation:

Enter the USB ID into the Configuration

Enter the USB ID

Complete Guide to CAN Toolboard Setup

Preparations

CAN Network Configuration Requirements

Connect via SSH

Search for CAN ID

Search Result Explanation

Configure CAN Device ID

1. Obtain the Configuration File

2. Add Device Configuration

3. Save and Restart

Searching for the RS232 ID of the Toolboard

Precautions

RS232 Notes

Searching for the RS232 ID

Configuring the Toolboard RS232 ID

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