Important Notes
- This tutorial specifically covers the wiring and ID search for toolboards. The related steps are not applicable to mainboards. 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 |
| Expansion 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 |
Notes
- Ensure the tool board has been flashed with
USBfirmware before performing any operations; - This tutorial is only applicable for searching the tool board ID, not for searching the main board ID;
- Please perform subsequent operations only after the host computer is properly connected to the tool board;
Connect to SSH
- Please first log in to
SSHvia the network - Please ensure that you are logging in to
SSHvia the network, not via serial port
Search for Device
- Please ensure the host computer is connected to the Internet and that the data cable connecting the device to the host computer supports data transfer.
- After SSH connecting to the host computer, enter
lsusband press Enter. If you see the information circled in the image below, you can proceed to the next step.- If no information is displayed, this indicates a system issue with the host computer. We cannot assist with this, and you will need to replace the system with a confirmed working one or change the host computer.
- If the
lsusbcommand is not found, install it by running the following command:sudo apt-get install usbutilsLoading...
1d50:614eis the device you will use in this process.- Some host computers may fail to fully display or not display the information due to system issues.
- If the device is shown after running the
lsusbcommand but1d50:614eis missing, try using a different data cable or connect the main board to another USB port on the host computer.
You must proceed to the next step only after one of the 1d50:614e devices is found.
Search for USB ID
ls /dev/serial/by-id/*
- Enter the command below and press Enter. If everything works properly, a blue ID like the one below will appear. (The example below is just for reference)
- If no ID appears after entering the command, but the device appears with
lsusb, please change the host computer or its operating system
If multiple IDs appear, please choose the corresponding ID based on your main board's MCU model.
Insert the USB ID into the configuration
Loading... |
Loading... |
Note: All IDs appearing in this document are examples. Each main board's ID is different in practice. Please modify and enter according to the actual ID you obtained.
Enter the Tool Board USB ID
-
Below is a sample configuration
Note- The
toolboardin the configuration below refers to the tool board name; please replace it with the appropriate name if it is different
dangerous[mcu toolboard]
serial: <Replace this with the ID you just looked up>- To add the
IDof the tool board, it must be[mcu toolboard]followed byserial:and then the ID of the tool board you searched for
- Below is a sample configuration
- Please note that this tutorial is specifically for searching and configuring the tool board ID; normally, it should already be connected to the main board
- And the main board must be
[mcu], while the tool board is[mcu toolboard]
- Fluidd reference
Loading...- Mainsail reference
Loading...- Click
SAVE & RESTARTat the top right corner, which will automatically save and restart klipper
- The
- CAN Reference Wiring
- Termination Resistor Configuration Check:
Device Configuration Method Target State Mainboard Locate the jumper block or DIP switch labeled 120ΩInstall jumper cap or switch to ONToolboard Locate the jumper block or DIP switch labeled 120ΩInstall 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
Interface Configuration Guide
Precautions
- Firmware Requirements:
The toolboard must be flashed with RS232 firmware, otherwise communication will not be possible. - Common Ground Required:
⚠️ Before connecting the toolboard, ensure it shares the same power supply asC8Por connect the toolboard's GND to the mainboard's GND (sharing the same24V/12Vpower supply will suffice). - Interface Features:
- Dual RS232 interfaces support independent operation and simultaneous use of both interfaces
- Klipper's
serial:parameter is fixed in hardware and cannot be modified
Wiring Standards
|
|
- Left Interface (SERIAL3)
- Right Interface (UART4)
Configuration Steps
- Edit printer.cfg
[mcu Laser]
serial: /dev/serial3 # Fixed device node for the left interface
baud: 250000
restart_method: command - Key Configuration Notes
Laserin[mcu Laser]can be customized/dev/serial3is the dedicated node for the left interface and cannot be changed
Configuration Steps
- Edit printer.cfg
[mcu ToolBoard]
serial: /dev/serial4 # Fixed device node for the right interface
baud: 250000
restart_method: command - Key Configuration Notes
ToolBoardin[mcu ToolBoard]can be customized/dev/serial4is the dedicated node for the right interface and cannot be changed
Configuration ID
- Open a browser and enter the host computer's IP address in the address bar. For example, if my host computer's IP is
192.168.101.179, simply type it in and press Enter.
- Open the host computer's web interface, and under the configuration options in the left sidebar, find:
Loading... |
Loading... |
- Fill in the corresponding ID
Loading... | Loading... |
-
Apply Configuration
- After pasting the configuration code into the appropriate area
- Click SAVE & RESTART in the upper right corner
-
If Klipper displays
ADC out of range, this is normal. Connect the heated bed and thermistor to the mainboard, configure the thermistor pins for the nozzle and heated bed, then save and restart.