Important Notes
- This tutorial specifically covers the wiring and ID search for toolboards. The related steps are not applicable to mainboards. Please note the distinction.
- 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
USB Connection Method
Supported Devices
| Device Type | Connection Method | Requirements / Prerequisites |
|---|---|---|
| Toolboard | Connect to the USB-A port on the D8-Pro mainboard | Requires flashing USB communication firmware |
| Extended Mainboard | Connect to the USB-A port on the D8-Pro mainboard | Requires flashing USB communication firmware |
| USB Camera | Connect to the USB-A port on the D8-Pro mainboard | Must be a driverless plug-and-play type |
| USB Flash Drive | Connect to the USB-A port on the D8-Pro mainboard | Recommended to format with FAT32 file system |
Precautions
Before starting to search for the Tool Board ID, please ensure that all the following conditions are met:
- Firmware Preparation: The tool board has been flashed with
USBfirmware or is currently inUSBflashing mode. - Clear Objective: This tutorial is only for searching the Tool Board ID and is not applicable to the Main Board ID.
- Hardware Connection: The Tool Board is correctly connected to the host computer's
USB-Aport 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.
Search 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 above, but
lsusbshows the device, please try a different host computer or change the host computer's operating system.
If multiple IDs appear, please select the one corresponding to your main board's MCU model.
Fill the USB ID into the Configuration
Loading... |
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 obtained.
Fill in the Tool Board USB ID
-
Below is a reference configuration.
Notetoolboardin the configuration below refers to the tool board name. If it has a different name, please replace it with the corresponding name.
dangerous[mcu toolboard]
serial: <Replace here with the ID you just queried>- When adding the Tool Board
ID, it must be[mcu toolboard]followed byserial:and then the tool board ID you searched for.
- Below is a reference configuration.
- Please note this tutorial is for Tool Board ID search and configuration. Normally, the tool board should already be properly connected to the main board.
- And the main board must be
[mcu], while the tool board is[mcu toolboard].
- Reference for fluidd.
Loading...- Reference for mainsail.
Loading...- Click the
SAVE & RESTARTbutton in the upper 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 block or DIP switch labeled 120ΩPlace jumper cap or switch to ONToolboard Locate the jumper block 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.
Complete Guide to CAN Toolboard Setup
Preparations
- Toolboard Status: Ensure the toolboard is flashed with
Klipper-canfirmware or is inKatapult-canmode. - 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
UTOCmodule - A mainboard flashed with
USB-to-CAN Bridgefirmware
- A
- 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
- Important Note: The mainboard ID has already been configured in Klipper in previous documentation. Under normal circumstances, the mainboard's
CANIDcannot 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.) |
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 Loading... | Mainsail Loading... |
2. Add Device Configuration
Add the toolboard configuration to printer.cfg:
[mcu toolboard]
canbus_uuid: <Enter the queried ID here>
toolboardis 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.
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.
- RS232 Reference Wiring
Searching for the RS232 ID of the Toolboard
Precautions
- 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 same24V/12Vpower supply achieves this).
RS232 Notes
- Only the D8, D8PRO, and C8P mainboards support the RS232 interface. Other mainboards do not.
- For unsupported mainboards, use
G2TorUTORfor 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:
Loading... |
Loading... |
- Click
printer.cfg, then clickDEVICESin the top right corner.
Loading... | Loading... |
- Click
SERIAL, then refresh.
Loading... |
Loading... |
- Copy the ID. Click the indicated arrow to copy.
Loading... |
Loading... |
- When connecting the toolboard using
UTOR, twoRS232_IDs often appear. Try each one.
Configuring the Toolboard RS232 ID
-
Below is a reference configuration.
Note- In the configuration below,
toolboardrefers 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 byserial:, 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 & RESTARTin the top right corner. This will automatically save and restart Klipper.
- In the configuration below,