Important Notes
- This tutorial specifically introduces wiring and searching for IDs on the tool board. The related steps do not apply to the mainboard. Please make sure to distinguish between them.
- If you are not using a tool board, please ignore this tutorial.
Tool Board ID Reading and Viewing
- USB ID Retrieval
- CANBus UUID Retrieval
- Prepare a data cable with data transfer capability. If the length is particularly long, it is recommended to use a cable with a ferrite core.
- Connect the tool board to the host computer via a USB data cable.
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
-
Before searching for the ID, use an XT30 data cable to connect the tool board to the UTOC or a mainboard flashed with bridging firmware. Below is a reference wiring diagram.
-
Please ensure the DIP switches are set correctly.
Loading... -
Make sure to measure the resistance between CAN H and CAN L using a multimeter while powered off. It should be around
60Ω. If it is120Ω, then install the120Ωjumper. If it is around40Ω, remove the jumper.Loading...Complete Guide to CAN Toolboard Setup
Preparations
Important Prerequisites- Toolboard Status: Ensure the toolboard is flashed with
Klipper-canfirmware or is inKatapult-canmode. - Applicable Scope: This tutorial is only for Toolboard ID searching, not for Mainboard ID searching.
- Connection Requirements: The toolboard must be connected to one of the following devices:
- A
UTOCmodule. - A mainboard flashed with
USB Bridge CANfirmware.
- A
- Final Connection: The aforementioned device needs to be connected to the host computer.
Hardware Connection and Termination Resistor Configuration
Safety First- Complete Power Off: All wiring operations must be performed with the devices completely powered off.
- Prevent Short Circuits: Please disconnect power to all devices before operation.
Connection Specification Table
Device Type Termination Resistor Requirement Configuration Method CAN Toolboard Requires a 120Ωtermination resistorEnable via jumper cap or DIP switch Mainboard CAN Interface Requires a 120Ωtermination resistorEnable via jumper cap or DIP switch UTOC Module Has a built-in 120ΩresistorNo additional connection needed Configuration and Measurement Steps
-
Hardware Configuration
- Check if the
120Ωjumper cap or DIP switch near the mainboard's CAN interface is connected or turned on. - Check if the
120Ωjumper cap or DIP switch on the toolboard is connected or turned on.
- Check if the
-
Resistance Measurement (with power off)
- Measurement Points: Between CAN-H and CAN-L.
- Tool: Multimeter.
Resistance Value Troubleshooting Table
Notes- Measurement must be performed with the power off.
- If the measurement is around
140Ω, it may be due to CAN-H and CAN-L being swapped.
Measured Value Status Possible Cause Solution Around 60Ω✅ Normal Termination resistors correctly connected at both ends Configuration complete Around 120Ω❌ Abnormal Line broken or not connected Check all connections Around 40Ω❌ Abnormal Three ends have resistors connected Remove the middle resistor Important Notes
- UTOC Module: Has a built-in resistor. The mainboard does not need a termination resistor when connected to it.
- Connection Scenarios:
- Toolboard ↔ Mainboard (both ends need termination resistors).
- Toolboard ↔ UTOC ↔ Host Computer (only the toolboard needs a termination resistor).
- Troubleshooting Process:
Measure resistance → 60Ω → Ready for use
↓
Abnormal value → Check table above → Adjust and remeasure
Hardware Checklist
- All devices completely powered off.
- Mainboard CAN interface termination resistor connected (except for UTOC).
- Toolboard termination resistor connected.
- Multimeter measures resistance ≈60Ω.
- CAN-H and CAN-L wiring is correct and secure.
Professional AdviceCorrect termination resistor configuration is crucial for CAN bus communication quality. Deviations in resistance values may lead to unstable communication or data loss.
CAN Network Configuration Requirements
- Default Configuration: This tutorial assumes the host computer's CAN network is already configured.
- Fly System Users: If using a Fly host computer running Fly-FAST or Fly-Armbian system, CAN is configured by default (rate 1Mbps).
- First-time Users: Please be sure to read the tutorial below first: CAN Configuration Tutorial
Summary Process
- Hardware Preparation: Wire with power off, configure termination resistors, measure and confirm 60Ω.
- Network Confirmation: Ensure the host computer's CAN network is correctly configured.
- Connect to Host: Connect to the host computer via UTOC or a USB-bridged mainboard.
- Firmware Status: Confirm the toolboard is in Klipper-can or Katapult-can mode.
- Subsequent Operations: Proceed with ID search and configuration as per the following tutorials.
At this point, your CAN toolboard hardware connection and network environment are ready. You can proceed with ID search and configuration operations.
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 devices.
Search for Devices
- Now that you have successfully logged into the host computer, you can enter
lsusbto search for devices. You may encounter one of the following situations:- If entering
lsusbprompts that thelscommand is not found, you can install the required utility by entering the following command:sudo apt-get install usbutils - If there is no response after entering
lsusb, this is a system issue and cannot be resolved here. You will need to change the system or use a known working system. - If information like that shown in the image below appears, please note that this is only a reference. You only need to confirm that
1d50:606fappears:Loading...
- If entering
1d50:606fis the device you will use in this instance.- If multiple
1d50:606fdevices appear, one must be excluded, as multiple entries may affect subsequent flashing and firmware connection. For example, withFLY MINI PAD, it is recommended to use the onboardUTOCand avoid using other CAN bridges. - If the device does not appear, please check whether the data cable is properly connected and whether the correct firmware has been flashed.
NoteYou can proceed to search for the CAN ID only when
1d50:606fappears.Search for CAN ID
- Fly-Armbian / Generic System
- Fly-FAST System
Execute the following command to search for CAN device IDs:
~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0Execute the following command to search for CAN device IDs:
python ~/klipper/scripts/canbus_query.py can0Search Result Explanation
After executing the search command, the following situations may occur:
Result Display Status Description Next Steps Application: KlipperDevice is flashed with Klipper firmware Can use this ID directly Application: CANBOOTorKatapultDevice is in Bootloader mode Needs to be flashed with Klipper firmware before use Total 0 uuids foundNo devices found Please check the following:
1. Is the CAN network configured correctly?
2. Is the CAN rate consistent? (Default 1Mbps)
3. Is the ID already used in the configuration? (Need to comment it out, save, power off, and restart)Loading...About Duplicate IDsIf a device ID is already configured in
printer.cfg, it will not appear in the search results. To search again, please:- Comment out the 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.cfgconfiguration file based on the web interface you are using:Fluidd
Click theicon in the left navigation bar, find{...}printer.cfg.Loading...Mainsail
ClickMachinein the top navigation bar, findprinter.cfg.Loading...2. Add Device Configuration
Add the toolboard configuration in
printer.cfg:[mcu toolboard]
canbus_uuid: <Fill in the queried ID here>Configuration Notetoolboardis the toolboard name, please modify according to your actual situation.- For a mainboard ID, the configuration section should be
[mcu]. - In a normal configuration, the mainboard uses
[mcu], and the toolboard 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.
Loading...NoteAll IDs appearing in the documentation are examples. The actual ID for each mainboard is different. Please modify and fill in according to the ID you actually obtained.
- Toolboard Status: Ensure the toolboard is flashed with