Important Notes

Notes

• This tutorial specifically introduces wiring and searching for IDs on the toolboard. The related steps do not apply to the mainboard, please make sure to distinguish them.
• If you are not using a toolboard, please ignore this tutorial.

Toolboard ID Reading and Viewing

USB ID Retrieval

Notes

Important

• Ensure the tool board has been flashed with USB firmware 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 SSH via the network
• Please ensure that you are logging in to SSH via 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 lsusb and 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 lsusb command is not found, install it by running the following command:

    sudo apt-get install usbutils

    
• 1d50:614e is 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 lsusb command but 1d50:614e is missing, try using a different data cable or connect the main board to another USB port on the host computer.

Note

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

Note

If multiple IDs appear, please choose the corresponding ID based on your main board's MCU model.

Insert the USB ID into the configuration

fluidd is: {…}, click into it and you can find printer.cfg

mainsail is: Machine, click into it and you can find printer.cfg

dangerous

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 toolboard in 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 ID of the tool board, it must be [mcu toolboard] followed by serial: 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

  Mainsail reference

  • Click SAVE & RESTART at the top right corner, which will automatically save and restart klipper

CANBus UUID Retrieval

• CAN Reference Wiring
  
  • The 120Ω jumper must be connected
  

  Notes

  Notice

  • Ensure the tool board has been flashed with CAN firmware before the operation;
  • This tutorial is only applicable for searching the tool board ID, not for the main board ID;
  • Please connect the tool board to UTOC or a main board flashed with USB to CAN firmware;
  • Then connect the UTOC or the main board with USB to CAN firmware to the host computer before proceeding with the following operations.

  CAN Notes

  • This tutorial assumes your host computer has already been configured for CAN.
  • If you are using a Fly host computer and running either the Fly-Armbian or Fly-FAST system, CAN is already configured by default with a CAN speed of 1M.
  • If this is your first time using CAN, please read the tutorial below first.
  • CAN Configuration Tutorial

  Connect to SSH

  • First, log in to SSH via the network.
  • Please note that you must use network login to SSH, not serial port login.

  Search for Devices

  • Now that you have successfully logged into the host computer, you can enter lsusb to search for devices. You may encounter one of the following situations:
    • If entering lsusb prompts that the ls command 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:606f appears:
      
  • 1d50:606f is the device you will use in this instance.
  • If multiple 1d50:606f devices appear, one must be excluded, as multiple entries may affect subsequent flashing and firmware connection. For example, with FLY MINI PAD, it is recommended to use the onboard UTOC and 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.
  Note

  You can proceed to search for the CAN ID only when 1d50:606f appears.

  Search for CAN ID

  Search Method Using Fly_Armbian or Regular Host

  • Enter the following command to search for the ID:

  ~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0

  Search Method Using Fly_FAST

  • Enter the following command to search for the ID:

  python ~/klipper/scripts/canbus_query.py can0

  • After executing the search command, there may be several situations as follows. Please check and judge according to your own case:
    • If an ID appears and the Application: at the end shows Klipper, it means this ID can be used directly.
    • If an ID appears and the Application: at the end shows CANBOOT or Katapult, it means the firmware needs to be flashed before use.
    • If Total 0 uuids found appears, there may be several possible situations:
      • There is an issue with the CAN network configuration.
      • The CAN speed is inconsistent. Please ensure that the CAN speed of the host computer, main board, tool board, etc., is consistent.
      • The corresponding ID has already been configured in Klipper. You need to disable the ID in the system configuration, then shut down, power off, and restart.
        

  Fill the CAN ID into the configuration

  • Copy the queried UUID and then configure it into printer.cfg.

  • If the Application: shows Canboot, you cannot configure it into the configuration. You need to flash the Klipper firmware to proceed to the next step.

    
    dangerous

    Note: All IDs appearing in the document are examples. The ID of each main board is different in practice. Please modify and fill in according to the actual ID obtained.

  For fluidd: {…}, click into it to find printer.cfg

  For mainsail: Machine, click into it to find printer.cfg

  • The following is a reference configuration:

    Notes

    • The toolboard in the configuration below refers to the name of the tool board. If it has a different name, please replace it accordingly.
    dangerous

    [mcu toolboard]
    canbus_uuid: <Replace this with the ID you just queried>

    • The following is a reference configuration method for the MCU ID in the case of one main board plus one tool board.
    • If it is a main board ID, it must be [mcu toolboard] followed by canbus_uuid: and then the ID you searched for.
    • The following is a reference configuration:
    • Please note that this tutorial is for searching and configuring the tool board ID. Under normal circumstances, it is already properly connected to the main board.
    • And the main board must be [mcu], while the tool board is [mcu toolboard]
    
    • Click the SAVE & RESTART button in the upper right corner. It will automatically save and restart Klipper after clicking.