Important Notes
- 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 Retrieval
- CANBus UUID Retrieval
- RS232 Usage Method
- Prepare a data cable with data transfer functionality. If the cable is particularly long, it is recommended to use a data cable with a ferrite core.
- Connect the Toolboard to the host computer via the USB data cable.
Notes
- You must connect to the host via SSH, use a network login method to connect to the host (such as a Raspberry Pi)
- Ensure the motherboard has been flashed with USB firmware before proceeding
- This tutorial is only applicable for motherboard ID search, not for toolboard ID search
- Make sure the motherboard is connected to the host's USB port via TYPEC
- To view the toolboard ID, please refer to the relevant tutorial under the corresponding product directory
Steps
Search for USB Device ID
- Run the following command to list all USB serial device IDs:
ls /dev/serial/by-id/*
⚠️ Important: Unusable IDs
After executing the command, please pay attention to identifying and avoid using the following two types of IDs:
| ID Feature | Reason Explanation | Example |
|---|---|---|
usb-1a86_USB_Serial-if00-port0 | This is the default name for generic serial chips like CH340, cannot be used for configuration. | /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0 |
Contains katapult | Indicates the device is in flash mode, Klipper firmware must be flashed before use. | /dev/serial/by-id/usb-katapult_xxxxxxxxxxxx |
Result Explanation:
- Normal Case: The terminal will display an ID similar to the following (image below is just an example)
Loading...
- Troubleshooting Abnormal Issues
If multiple IDs appear, select the corresponding ID based on your motherboard's MCU model
Fill the USB ID into the Configuration
Loading... |
Loading... |
Note: All IDs shown in the document are examples. Each motherboard's ID is different. Modify based on the actual ID obtained.
Fill in the USB ID
- Find
[mcu], then replace
- Please replace the content in the configuration file:
- Do not configure
canbus_uuid:
[mcu]
serial: <Replace this with the ID you just queried>
- Reference
Loading... |
Loading... |
- Click
SAVE & RESTARTin the top right corner. It will automatically save and restart Klipper.
-
Before searching for the ID, connect the Toolboard to a UTOC or a Mainboard flashed with bridge firmware using an XT30 power 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 is120Ω, you need to install a120Ωjumper. If it is around40Ω, you need to remove the jumper.Loading...Complete Guide to CAN Toolboard Setup
Preparation
Important Prerequisites- Toolboard Status: Ensure the toolboard has been flashed with
Klipper-canfirmware or is inKatapult-canmode - Note: This guide is only for toolboard ID search, not applicable for motherboard ID search
- Connection Requirements: The toolboard must be connected to one of the following devices:
UTOCmodule- A motherboard flashed with
USB bridge CANfirmware
- Final Connection: The above devices must be connected to the host computer
CAN Network Configuration Requirements
- Default Configuration: This guide assumes the host computer has already configured the CAN network
- Fly Users: If using a Fly host computer running the Fly-FAST system, CAN is configured by default (rate 1Mbps)
- First Time Use: Please read the following tutorial first: CAN Configuration Guide
Connect to SSH
- Log in to SSH via network (Do not use serial port login)
- Ensure the host computer is properly connected to the CAN network device
Search for CAN ID
- Standard host computer search command
~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0
- FLY host computer search command
python3 ~/klipper/scripts/canbus_query.py can0
Search Results Explanation
CANID- Note: The motherboard ID has already been configured in Klipper in previous documentation; under normal circumstances, the motherboard's
CANIDcannot be found - Quick verification method: If confirmation is needed, first disconnect the CAN connection cable between the motherboard and the toolboard, then re-execute the search
- After executing the search command, the following situations may occur:
Display Result Status Description Next Steps Application: KlipperDevice has been flashed with Klipper firmware Can use this ID directly Application: CANBOOTorKatapultDevice is in Bootloader mode Must flash Klipper firmware before use Total 0 uuids foundNo devices found Check the following issues:
1. Is the CAN network configured correctly
2. Are CAN rates consistent (default 1Mbps)
3. Is the ID already used in the configuration (disable, save, power cycle first)Loading...About Duplicate IDsIf a device ID is already configured in
printer.cfg, it will not appear in the search results. To re-search, please:- Comment out the device ID in the configuration file
- Save the configuration and restart Klipper
- Power cycle all devices
Configure CAN Device ID
1. Obtain Configuration File
Depending on the web interface used, locate the
printer.cfgconfiguration file:Fluidd
Click the{...}icon in the left navigation bar, findprinter.cfgLoading...Mainsail
ClickMachinein the top navigation bar, findprinter.cfgLoading...2. Add Device Configuration
Add the toolboard configuration to
printer.cfg:[mcu toolboard]canbus_uuid: <fill in the queried ID here>Configuration Explanationtoolboardis the toolboard name; modify it according to the actual situation- If it is a motherboard ID, the configuration section should be
[mcu] - In normal configuration, the motherboard uses
[mcu], and the toolboard uses[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
Loading...NoteAll IDs appearing in this document are examples only; each motherboard's ID is different. Please modify and fill in based on the actual ID obtained.
- Toolboard Status: Ensure the toolboard has been flashed with
-
Before searching for the ID, connect the Toolboard to a UTOR or G2T using an XT30 power cable. The reference wiring diagram is below.
-
Please check if the DIP switch is set to the correct position.
Loading...Search Toolboard RS232 ID
Precautions
Important Preparation- Firmware Requirements:
The toolboard must be flashed with RS232 firmware, otherwise communication is not possible. - Mandatory Common Ground:
⚠️ Before connecting the toolboard, ensure that the toolboard and the motherboard share the same GND (using the same24V/12Vpower supply is sufficient).
RS232 Precautions
- Except for D8, D8PRO, and C8P, which support the RS232 interface, other motherboards do not support the RS232 interface.
- Motherboards that do not support RS232 need to use
G2TorUTORfor connection.
Search for RS232 ID
- Open a browser and enter the IP address of the host computer in the address bar. For example, if my host computer IP is
192.168.101.179, simply enter it and press Enter.
Loading...- Open the WEB interface of the host computer. In the configuration options on the left sidebar, find:
- For fluidd:
{…}, click it to findprinter.cfg
Loading...- For mainsail:
Machine, click it to findprinter.cfg
Loading...- Click on
printer.cfgto enter, then clickDEVICESin the upper right corner.
Loading...Loading...- Click
SERIAL, then refresh.
- Refresh in fluidd
Loading...- Refresh in mainsail
Loading...- Copy the ID by clicking the arrow indicated.
- In fluidd, confirm if
ch341-uartexists, then clickPath_by_hardware. This is the RS232_ID.
Loading...- In mainsail, confirm if
CH341-UARTexists, then clickPath_by_hardware. This is the RS232_ID.
Loading...Note- When using
UTORto connect the toolboard, there are usually twoRS232_IDs. Try each one.
Fill in the Toolboard RS232 ID
-
Below is a reference configuration.
Note- In the configuration below,
toolboardrefers to the toolboard name. If you have a different name, replace it accordingly.
Danger[mcu toolboard]serial: <Replace here with the ID you just found>baud: 250000restart_method: command- To add the toolboard's
ID, it must be[mcu toolboard]followed byserial:and the toolboard ID you found.
- Below is a reference configuration.
- Please note that this tutorial is for searching and configuring the toolboard ID. Normally, the toolboard should already be properly connected to the motherboard.
- The motherboard must be
[mcu], and the toolboard must be[mcu toolboard]. - Click
SAVE & RESTARTin the upper right corner to automatically save and restart Klipper.
- In the configuration below,
DangerNote: All IDs appearing in this document are examples. The actual ID of each motherboard is different. Please fill in the ID you actually obtained.
- Firmware Requirements: