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 on the D8-Pro Mainboard | Requires flashing the USB Communication Firmware |
| Expansion Mainboard | Connect to the USB-A port on the D8-Pro Mainboard | Requires flashing the 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 the FAT32 file system |
Precautions
Before starting to search for the toolboard ID, please ensure that all of the following conditions are met:
- Firmware Preparation: The toolboard has been flashed with the
USBfirmware or is currently inUSBflashing mode. - Clear Objective: This tutorial is only for searching for the toolboard ID and does not apply to the mainboard ID.
- Hardware Connection: The toolboard 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, 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 ID corresponding to your mainboard's MCU model.
Fill the USB ID into the configuration
Loading... |
Loading... |
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.
Fill in the Toolboard USB ID
-
Below is a reference configuration:
Notetoolboardin the configuration below refers to the toolboard 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>- Adding the toolboard
IDmust always be[mcu toolboard]followed byserial:and then the toolboard ID you searched for.
- Below is a reference configuration.
- Please note this tutorial is for toolboard ID search and configuration. Under normal circumstances, it should already be properly connected to the mainboard.
- And the mainboard must be
[mcu], while the toolboard 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 socket or DIP switch labeled 120ΩPlace the jumper cap or switch to ONToolboard Locate the jumper socket or DIP switch labeled 120ΩPlace the 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 Tool Board Setup
Preparations
- Tool Board Status: Ensure the tool board is flashed with
Klipper-canfirmware or is inKatapult-canmode. - Important Note: This tutorial is only for searching Tool Board IDs, not for Main Board IDs.
- Connection Requirements: The tool board must be connected to one of the following devices:
UTOCmodule- A main board flashed with
USB Bridge CANfirmware.
- Final Connection: The above device must be connected to the host machine.
CAN Network Configuration Requirements
- Default Configuration: This tutorial assumes the CAN network is already configured on the host machine.
- Fly Users: If using a Fly host machine 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 machine is properly connected to the CAN network device.
Search for CAN ID
- Search command for a standard host machine:
~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0 - Search command for a FLY host machine:
python3 ~/klipper/scripts/canbus_query.py can0
Search Result Explanation
- Important Note: The main board ID has already been configured in Klipper in previous documentation. Under normal circumstances, the main board's
CANIDcannot be found via search. - Quick Verification Method: If confirmation is needed, first disconnect the CAN cable between the main board and the tool board, then re-execute 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. Has this ID already been used in the configuration? (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
Find the printer.cfg configuration file based on the web interface you are using:
Fluidd Loading... | Mainsail Loading... |
2. Add Device Configuration
Add the tool board configuration in printer.cfg:
[mcu toolboard]
canbus_uuid: <Enter the queried ID here>
toolboardis the name of the tool board. Please modify it according to your actual situation.- For a main board ID, the configuration section should be
[mcu]. - In a normal configuration, the main board uses
[mcu], and the tool board uses[mcu toolboard].
3. Save and Restart
- Click the SAVE & RESTART button in the top 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 main board 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
Important Notes
- Firmware Requirement:
The toolboard must be flashed with the RS232 firmware, otherwise communication will not be possible. - Mandatory Common Ground:
⚠️ Before connecting the toolboard, you must ensure its GND is connected to the mainboard's GND (sharing the same24V/12Vpower supply will achieve this).
RS232 Notes
- Besides the D8, D8PRO, and C8P, which support the RS232 interface, other mainboards do not support the RS232 interface.
- For unsupported mainboards, you need to use a
G2TorUTORfor connection.
Searching for the RS232 ID
- Open a browser, enter the host's IP address in the address bar (for example, if the host IP is
192.168.101.179, enter it directly and press Enter).
- Open the host's WEB interface, and find the following in the configuration options on the left sidebar:
Loading... |
Loading... |
- Click into
printer.cfg, then clickDEVICESin the upper right corner.
Loading... | Loading... |
- Click
SERIAL, then refresh.
Loading... |
Loading... |
- Copy the ID. Click where the arrow points to copy.
Loading... |
Loading... |
- When using
UTORto connect the toolboard, twoRS232_IDs often appear. Please try them one by one.
Filling in the Toolboard RS232 ID
-
Below is a reference configuration.
Notes- 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- Adding the toolboard
IDmust be[mcu toolboard]followed byserial:and then the toolboard ID you searched for.
- Below is a reference configuration.
- Please note this tutorial is for toolboard ID search and configuration. Normally, it is already properly connected to the mainboard.
- The mainboard must be
[mcu], and the toolboard is[mcu toolboard]. - Click
SAVE & RESTARTin the upper right corner. Clicking will automatically save and restart Klipper.
- In the configuration below,
Note: All IDs appearing in the document are examples. The actual ID for each mainboard is different. Please fill in the ID you actually obtained.