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 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 |
Precautions
Before starting to search for the toolboard ID, please ensure that all the following conditions are met:
- Firmware Preparation: The toolboard has been flashed with
USBfirmware, or is currently inUSBflashing mode. - Clear Objective: This tutorial is only for searching for the toolboard ID, not applicable for the motherboard ID.
- Hardware Connection: The toolboard is correctly connected to the
USB-Aport of the upper computer via USB. - Login Method: Please log in to the upper computer via network SSH to operate, do not use serial port login.
Search for USB ID
ls /dev/serial/by-id/*
- Normal Condition: The terminal will display an ID similar to the one below (the image below is just an example)
Loading...
- If no ID appears after entering the command below, but the device is present with
lsusb, please replace the upper computer or its operating system
If multiple IDs appear, please select the corresponding ID based on your motherboard's MCU model.
Fill the USB ID into the configuration
Loading... |
Loading... |
Note: All IDs appearing in the document are examples. The actual ID for each motherboard will be different. Please modify and fill in the ID based on the one you actually obtain.
Fill in the Toolboard USB ID
-
Below is a reference configuration
Note- In the configuration below,
toolboardrefers to the name of the toolboard. If it is another name, please replace it with the corresponding name.
Danger[mcu toolboard]serial: <Replace here with the ID you just queried>- To add the toolboard
ID, it must be[mcu toolboard]followed byserial:and then the toolboard ID you found.
- Below is a reference configuration
- Please note that this tutorial is for searching and configuring the toolboard ID. Under normal circumstances, the motherboard should already be connected.
- Also, the motherboard must be
[mcu], and the toolboard must be[mcu toolboard]
- Reference for fluidd
Loading...- Reference for mainsail
Loading...- Click
SAVE & RESTARTin the upper right corner. After clicking, it will automatically save and restart klipper.
- In the configuration below,
- 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 ONToolboard 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.
Complete Guide to CAN Toolboard Setup
Preparation
- 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
- 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: Klipper | Device has been flashed with Klipper firmware | Can use this ID directly |
Application: CANBOOT or Katapult | Device is in Bootloader mode | Must flash Klipper firmware before use |
Total 0 uuids found | No 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) |
If 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.cfg configuration file:
Fluidd Loading... | Mainsail Loading... |
2. Add Device Configuration
Add the toolboard configuration to printer.cfg:
[mcu toolboard]
canbus_uuid: <fill in the queried ID here>
toolboardis 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
All 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.
- RS232 Reference Wiring
Search Toolboard RS232 ID
Precautions
- 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.
- Open the WEB interface of the host computer. In the configuration options on the left sidebar, find:
Loading... |
Loading... |
- Click on
printer.cfgto enter, then clickDEVICESin the upper right corner.
Loading... | Loading... |
- Click
SERIAL, then refresh.
Loading... |
Loading... |
- Copy the ID by clicking the arrow indicated.
Loading... |
Loading... |
- 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,
Note: All IDs appearing in this document are examples. The actual ID of each motherboard is different. Please fill in the ID you actually obtained.