BIGTREETECH Eddy series

Contents

BIGTREETECH Eddy Series User Manual

Models: Eddy, Eddy Coil, Eddy Duo

1. Introduction

This manual provides comprehensive instructions for the installation, configuration, operation, and troubleshooting of the BIGTREETECH Eddy series high-speed leveling tools, including Eddy, Eddy Coil, and Eddy Duo. These devices are designed to enhance the precision and efficiency of bed leveling for Klipper-based 3D printers.

1.1. Product Overview

The BIGTREETECH Eddy series offers advanced non-contact bed leveling solutions for 3D printers running Klipper firmware. They utilize eddy current sensing to precisely identify microscopic defects on the print bed and automatically adjust the nozzle height for fast and accurate leveling. The Eddy series is known for its compact size, lightweight design, high precision, and thermal stability.

BIGTREETECH Eddy series product image

Figure 1: BIGTREETECH Eddy series product overview.

Video 1: Demonstration of the Eddy sensor performing bed leveling on a 3D printer.

1.2. Feature Highlights

  • Compact size and lightweight (6g).
  • Equipped with thermal compensation (Eddy and Eddy Duo only).
  • Highly efficient leveling, achieving 20-second leveling for a 250x250mm bed.
  • Broad application and strong compatibility with various 3D printers using Klipper firmware.
  • High precision (0.5µm) and strong thermal stability.
  • Non-contact operation.
Eddy series feature highlights

Figure 2: Key features of the Eddy series leveling tools.

Eddy series vs Traditional Leveling Sensors speed comparison

Figure 3: Comparison of leveling speed between Eddy series and traditional sensors.

Eddy current principle diagram and precision details

Figure 4: Eddy current principle diagram illustrating its operation and precision.

1.3. Package Contents

The package contents vary slightly between the Eddy Coil and Eddy Duo models.

For Eddy Coil

  • 1x BTT Eddy Coil
  • 1x 150mm 4Pin Dupont Female Connector Cable
  • 5x Cable Ties
  • 2x M3*18 Mounting Screws
  • 2x M3*25 Mounting Screws (Voron Special)
  • 3x Stickers
  • 1x BTT Duck
Eddy Coil package contents

Figure 5: Eddy Coil package contents.

For Eddy Duo

  • 1x BTT Eddy Duo
  • 1x Customized 2.5m USB Cable
  • 3x Connector Housings
  • 6x Crimp Pins
  • 1x Connection Cable
  • 5x Cable Ties
  • 2x M3*18 Mounting Screws
  • 2x M3*25 Mounting Screws (Voron Special)
  • 3x Stickers
  • 1x BTT Duck
Eddy Duo package contents

Figure 6: Eddy Duo package contents.

Note: Eddy USB is currently out of stock and will be randomly shipped with Eddy Duo, which is an upgraded version. The Eddy Duo includes a USB/CAN dial selection switch, supports both USB or CAN communication, and adds a 200mm ZH1.5 to 4Pin DuPont head wiring for connecting EBB SB2209 CAN fan board CAN interface. It also features silk screen printing at the bottom center point for easy DIY parameter adjustment.

2. Specifications

The following table details the specifications for the Eddy series products:

ParameterEddy CoilEddyEddy Duo
MCU--RP2040
Temperature Compensation-✓✓
Product Weight6g6g6g
Voltage5V5V5V
Static Current30mA30mA30mA
Operating Current30mA30mA30mA
Cable Length15 cm2.5 m2.5 m
Connection4-2.54mm DuPont female header, one end with ZH1 5mm 4P connector4-pin, 1.5mm pitch4-pin, 1.5mm pitch
Operating Temperature≤60°C Ambient≤60°C Ambient≤60°C Ambient
Standard Error0.5μm0.5μm0.5μm
Compatible ModelsAll FDM printers that use the Klipper firmware.
FirmwareKlipper
Z-homing Device RequiredYesNoNo
BoardsRequires connection to Klipper-based mainboards via tool boards such as EBB36/42 CAN, which have I2C interfaces for proper functionality.Boards running Klipper with a USB interface.Boards running Klipper with a CAN/USB interface.
Heated BedRequires a conductive metal print bed with a uniform magnetic field.
Specifications table for Eddy Coil, Eddy, Eddy Duo

Figure 7: Detailed specifications for Eddy, Eddy Coil, and Eddy Duo.

2.1. Product Dimensions and Interfaces

The Eddy series devices are compact and designed for easy integration.

Eddy Duo dimensions diagram

Figure 8: Dimensions of the Eddy Duo (33.79mm x 18.09mm x 18.3mm).

Eddy series dimensions diagram

Figure 9: Detailed dimension diagram for the Eddy series.

The coil's center point, used for calculating XY offsets, is crucial for accurate calibration. Refer to the diagram for its location.

Location of the coil center point for XY offset calculation

Figure 10: Location of the coil center point for XY offset calculation.

2.2. Location of the BOOT Button

The BOOT button is used when programming Klipper onto the Eddy for the first time. Afterward, Klipper can automatically reprogram the RP2040.

Note:

Only Eddy and Eddy Duo have the BOOT function; the button on Eddy Coil is non-functional and will not operate.
Location of the BOOT button on Eddy and Eddy Duo

Figure 11: Exploded view showing the location of the BOOT button on Eddy/Eddy Duo.

3. Setup and Installation

3.1. Installation Height

Install the Eddy 2 to 3 mm above the nozzle to ensure optimal performance. If you encounter any errors during the calibration process, these may be related to incorrect installation height. The 20mm height mentioned in some calibration guides is only for coil current calibration, not the physical mounting height.

3.2. Example using Voron 2.4

For Voron 2.4, the Eddy replaces the original PL-08N position. Use two M3x25 screws (included) to secure the Eddy to the X Carriage.

Eddy installation example on Voron 2.4

Figure 12: Eddy installation on a Voron 2.4 X Carriage.

Eddy series compatibility with Voron StealthBurner, H2 series extruders, and Ender-3

Figure 13: Eddy series integration with Voron StealthBurner, H2 series extruders, and Ender-3.

3.3. Installation on Other Machines

Brackets for various machines are available on the BIGTREETECH GitHub repository and other model-sharing platforms. When installing, position the PCB side (rear) as far from the hotend as possible to reduce heat transfer.

Effortless Installation in Minutes diagram

Figure 14: Diagram illustrating effortless installation and internal components.

3.4. Wiring Diagrams

Proper wiring is essential for the correct function of your Eddy device. Refer to the diagrams below for specific board connections.

3.4.1. Eddy + Manta M5P (USB)

Wiring diagram for Eddy connected to Manta M5P via USB

Figure 15: Eddy connected to Manta M5P via USB.

3.4.2. Eddy + Manta M8P V2.0 (USB)

Wiring diagram for Eddy connected to Manta M8P V2.0 via USB

Figure 16: Eddy connected to Manta M8P V2.0 via USB.

3.4.3. Eddy Coil + EBB36 V1.2

Wiring diagram for Eddy Coil connected to EBB36 V1.2

Figure 17: Eddy Coil connected to EBB36 V1.2.

3.4.4. Eddy Coil + EBB42 V1.2

Wiring diagram for Eddy Coil connected to EBB42 V1.2

Figure 18: Eddy Coil connected to EBB42 V1.2.

Eddy Coil wiring with EBB36 CAN and Eddy - Simple Wiring with Manta M8P + CB1

Figure 19: Eddy Coil wiring with EBB36 CAN and Eddy simple wiring with Manta M8P + CB1.

3.4.5. Eddy Duo + MANTA M5P (USB)

Wiring diagram for Eddy Duo connected to Manta M5P via USB

Figure 20: Eddy Duo connected to Manta M5P via USB.

3.4.6. Eddy Duo + MANTA M5P (CAN)

Wiring diagram for Eddy Duo connected to Manta M5P via CAN

Figure 21: Eddy Duo connected to Manta M5P via CAN.

3.4.7. Eddy Duo + MANTA M8P V2.0 (USB)

Wiring diagram for Eddy Duo connected to Manta M8P V2.0 via USB

Figure 22: Eddy Duo connected to Manta M8P V2.0 via USB.

3.4.8. Eddy Duo + MANTA M8P V2.0 (CAN)

Wiring diagram for Eddy Duo connected to Manta M8P V2.0 via CAN

Figure 23: Eddy Duo connected to Manta M8P V2.0 via CAN.

Eddy Duo CAN/USB connection wiring diagrams

Figure 24: Eddy Duo CAN/USB connection wiring diagrams for various boards.

3.4.9. Eddy Duo + EBB36

Wiring diagram for Eddy Duo connected to EBB36

Figure 25: Eddy Duo connected to EBB36.

3.4.10. Eddy Duo + EBB42

Wiring diagram for Eddy Duo connected to EBB42

Figure 26: Eddy Duo connected to EBB42.

3.4.11. Eddy Duo + EBB SB

Wiring diagram for Eddy Duo connected to EBB SB

Figure 27: Eddy Duo connected to EBB SB.

3.4.12. Octopus V1.1/Pro V1.0/Pro V1.0.1 + Eddy Duo (USB)

Wiring diagram for Eddy Duo connected to Octopus V1.1/Pro V1.0/Pro V1.0.1 via USB

Figure 28: Eddy Duo connected to Octopus V1.1/Pro V1.0/Pro V1.0.1 via USB.

3.4.13. Octopus V1.1/Pro V1.0/Pro V1.0.1 + Eddy Duo (CAN)

Wiring diagram for Eddy Duo connected to Octopus V1.1/Pro V1.0/Pro V1.0.1 via CAN

Figure 29: Eddy Duo connected to Octopus V1.1/Pro V1.0/Pro V1.0.1 via CAN.

3.4.14. Octopus Pro V1.1 + Eddy Duo (USB/CAN)

Wiring diagram for Eddy Duo connected to Octopus Pro V1.1 via USB or CAN

Figure 30: Eddy Duo connected to Octopus Pro V1.1 via USB or CAN. Note: The specific connection type (USB or CAN) will depend on your configuration.

4. Operation and Configuration

4.1. Firmware

Important:

  • Eddy and Eddy Coil are ONLY compatible with Klipper installations using a Python 3 virtual environment. If you encounter "Internal error during connect: split() takes no keyword arguments", your Klippy host is likely using a Python 2 environment and needs upgrading. Use KIAUH to reinstall the Klippy host with Python 3.
  • Eddy Duo supports both USB and CAN communication. When switching from USB to CAN, it is recommended to update the firmware for CAN communication while still in USB mode. This simplifies the process, as DFU updating is easier than using KATAPULT.

4.1.1. Compiling Firmware

These instructions apply to Eddy and Eddy Duo. For Eddy Coil, connect it to an I2C port on a toolboard and compile firmware for that toolboard using the master Klipper branch. Configure Klipper to communicate via the I2C port.

If migrating from an old BIGTREETECH Klipper branch, use KIAUH to revert to the mainline branch and update firmware on all Klipper devices.

  1. Ensure you are using mainline Klipper by typing the following commands via SSH:
    cd ~/klipper
    git checkout master
  2. Next, type:
    make menuconfig
  3. Use the following settings to compile the firmware:
    For Eddy V1.0 (USB):
    • [*] Enable extra low-level configuration options
    • Micro-controller Architecture (Raspberry Pi RP2040/RP235x)
    • Processor model (rp2040)
    • Bootloader offset (No bootloader)
    • Flash chip (GENERIC_03H with CLKDIV 4)
    • Communication Interface (USBSERIAL)
    For Eddy Duo:
    • [*] Enable extra low-level configuration options
    • Micro-controller Architecture (Raspberry Pi RP2040)
    • Bootloader offset (16KiB bootloader)
    • Communication interface (CAN bus) (or USBSERIAL if using USB)
    • (4) CAN RX gpio number
    • (5) CAN TX gpio number
    • (1000000) CAN bus speed

    If not using KATAPULT:

    • Bootloader offset (No bootloader)
    • Flash chip (GENERIC_03H with CLKDIV 4)

    If using KATAPULT:

    (First carry out the procedure in section 4.1.3. Flashing KATAPULT)
    • Bootloader offset (16KiB bootloader)

    If using USB communication:

    • Communication Interface (USBSERIAL)
  4. Once set, hit 'Q' and select 'yes' to save.
  5. Enter make to compile the firmware. The klipper.uf2 firmware will be in home/pi/klipper/out.

4.1.2. Update Firmware via Computer

  1. Press and hold the Boot button, then connect Eddy to your computer's USB port. The device will appear as a storage drive. (Do not disassemble the Eddy; the button is accessible).
  2. Copy the downloaded klipper.uf2 file into the device. Eddy will automatically update its firmware and restart.
Eddy Coil V1.0 (Gray) product image

Figure 31: Eddy Coil V1.0 (Gray) model.

4.1.3. Flashing KATAPULT (formerly CanBoot)

Katapult is used for direct firmware updates via CAN bus.

  1. Download the Katapult project: https://github.com/Arksine/katapult
  2. Navigate to the Katapult directory via SSH:
    cd ~/katapult
  3. Enter make menuconfig and configure as follows:
    • Micro-controller Architecture (Raspberry Pi RP2040/RP235x)
    • Processor model (rp2040)
    • Flash chip (GENERIC_03H with CLKDIV 4)
    • Build Katapult deployment application (16KiB bootloader)
    • Communication Interface (CAN bus)
    • (4) CAN RX gpio number
    • (5) CAN TX gpio number
    • (1000000) CAN bus speed
    • [*] Support bootloader entry on rapid double click of reset button
    • [*] Enable Status LED
    • (gpio26) Status LED GPIO Pin
  4. Enter make to compile. The katapult.uf2 firmware will be in home/biqu/Katapult/out.

4.1.4. Updating Firmware via Katapult

Ensure the CAN bus cable is connected and the 120R termination resistor jumper is in place. The klipper.bin file must be generated beforehand.

  1. Input cd ~/katapult/scripts
  2. Query the CANbus ID: python3 flash_can.py -i can0 -q. Note the detected UUID.
  3. Flash the firmware: python3 flash_can.py -i can0 -f ~/klipper/out/klipper.bin -u [YOUR_UUID]. Replace [YOUR_UUID] with the one found in the previous step.
  4. Query again: python3 flash_can.py -i can0 -q. The application should now show "Klipper".

4.2. Klipper & Eddy Configuration

BIGTREETECH provides sample printer.cfg templates on their GitHub repository (https://github.com/bigtreetech/Eddy). Choose the template that best suits your needs:

  • Eddy as a probe, another device as z-endstop: Use config with no homing.
  • Eddy as both probe and z-endstop: Use config with homing.
  • Eddy as probe and z-endstop with beta z-offset functionality: Use config with homing and z-offset.

Copy the entire contents of the chosen template into your printer.cfg file. Adjust parameters as needed based on comments in the file.

4.2.1. Z-Endstop Configuration

You can use the Eddy as the Z endstop. If using another device, configure homing and endstop accordingly.

To enable Z-Homing/Endstop for Eddy:

  • In your [stepper_z] section in printer.cfg, change endstop_pin: PA5 to endstop_pin: probe:z_virtual_endstop and comment out or remove position_endstop: 0. Adjust PA5 if your current endstop pin is different.
  • Ensure the correct sample configuration file is copied entirely. If using a KNOMI, comment out conflicting macros in KNOMI.cfg and uncomment relevant Eddy macros.
  • Edit unique setup parameters in the config file, such as MCU serial, X/Y offset, Mesh min/max, and Home XY position.

Important:

The sample configuration requires adjusting x_offset and y_offset to match your probe position relative to your nozzle. Settings for the standard Voron X carriage mount are included in sample files.

4.3. Calibration

4.3.1. Drive Current Calibration

  1. Place Eddy approximately 20mm above the bed. If using Eddy as an endstop, manually move the gantry/bed to this height.
  2. From Mainsail or Fluidd, run:
    LDC_CALIBRATE_DRIVE_CURRENT CHIP=btt_eddy
  3. Type SAVE_CONFIG to save the drive current.

4.3.2. Mapping Eddy Readings to Nozzle Heights

This procedure maps Eddy readings to nozzle heights (Z=0 at bed level).

  1. Send the command:
    PROBE_EDDY_CURRENT_CALIBRATE_AUTO CHIP=btt_eddy
  2. Follow UI prompts to lower the nozzle until it pinches a piece of paper between itself and the bed (paper should still move with some force).
  3. Click 'accept' and watch Eddy perform mapping. Send SAVE_CONFIG when done.

4.3.3. Bed Mesh Calibration

  1. Home All Axes.
  2. If your printer supports Z-tilt or quad-gantry-level (QGL), run Z_TILT_ADJUST or QUAD_GANTRY_LEVEL to prevent nozzle collisions.
  3. Use command:
    BED_MESH_CALIBRATE METHOD=scan SCAN_MODE=rapid
  4. Once completed, use SAVE_CONFIG.
Rapid (Continuous) Scanning

Rapid scans are faster but may be less accurate. Improve them by configuring scan_overshoot in the bed_mesh section. Ensure axes can travel to mesh boundary plus overshoot. 8mm is usually sufficient.

Bed Mesh Scan Height

The scan height is set by horizontal_move_z in [bed_mesh], or via HORIZONTAL_MOVE_Z parameter with BED_MESH_CALIBRATE. A height of 2mm is typically effective.

4.3.4. Temperature Compensation Calibration (Eddy and Eddy Duo ONLY)

Important:

Eddy Coil does not have temperature compensation. Exercise caution as the heated bed can reach high temperatures.
  1. Home All Axes and move Z 5mm above the bed (G0 Z5).
  2. Set idle timeout:
    SET_IDLE_TIMEOUT TIMEOUT=36000
  3. Run:
    TEMPERATURE_PROBE_CALIBRATE PROBE=btt_eddy TARGET=56 STEP=4

    The TARGET value (e.g., 56) can be adjusted if your chamber reaches higher temperatures. Higher targets require longer soak times.

  4. Use the paper method to pinch a sheet of paper between the nozzle and the bed, then accept the value in the UI.
  5. Turn on your heat bed to maximum and nozzle to 220°C.
  6. Ensure the room is stable (no air conditioning or open windows) to allow Eddy's temperature to rise uninterrupted.
  7. As Eddy's temperature rises, you will be prompted to perform the paper pinch method at each 4°C interval. Be careful of hot surfaces.
  8. Repeat the paper test until calibration completes or Eddy's temperature stops increasing.

Tip:

Eddy thermal calibration accounts for both probe drift and thermal expansion of mechanical components. Perform calibration with the nozzle and heated bed both hot, and print with them both hot for best first layers.

5. Maintenance

The BIGTREETECH Eddy series leveling tools are designed for durability and require minimal routine maintenance. Regular firmware updates, as detailed in the "Operation and Configuration" section, are recommended to ensure optimal performance and access to the latest features and bug fixes. Beyond firmware updates and ensuring proper installation, no specific periodic maintenance is typically required for the hardware components.

Keep the device clean and free from dust or debris, especially around the sensor area, to maintain accuracy. Avoid physical impact or excessive force during handling and installation.

6. Troubleshooting (FAQ)

6.1. "Error during homing probe: Eddy current sensor error"

This error indicates the oscillator within the Eddy sensor is not at a valid value before probing. Try the following:

  1. Double-check probe height: It should be 2-3mm above the bed when the nozzle touches the bed (2.5mm is optimal). Adjust if too close or too high.
  2. Remove all calibration settings from your config file and recalibrate the Eddy.
  3. If the error persists, increase reg_drive_current to 16 (if currently 15).

6.2. "Probe Triggered Before Movement" Error

This happens when executing two successive PROBE commands. Always raise the gantry by a few millimeters between PROBE commands to avoid this.

6.3. Eddy is performing Z Hops when running Bed Mesh

Ensure you are using the correct macro call: BED_MESH_CALIBRATE METHOD=rapid_scan.

Also, remove or alter KAMP (Klipper-Adaptive-Meshing-Purging) and any custom BED_MESH_CALIBRATE macros. Use Klipper adaptive mesh instead, or do not include KAMP/Adaptive_Meshing.cfg in your KAMP_Settings.cfg. KAMP is integrated into Klipper as of January 2024; use ADAPTIVE=1 option in BED_MESH_CALIBRATE calls.

6.4. Which Eddy version should I use?

  • Eddy, Eddy Duo, and Eddy Coil are nearly identical. Eddy Coil is primarily for toolhead boards and connects via I2C.
  • Eddy Coil lacks temperature compensation, making it less reliable for homing in sealed chambers.
  • Eddy Duo supports both USB and CAN communication, while Eddy supports only USB.

6.5. "Error: gcode command < ANY GCODE COMMAND > already registered"

This occurs due to conflicting gcode macros. Check your gcode macros for duplicates and arbitrate conflicts. Generally, prioritize functionality from Eddy macros if unsure.

6.6. Z-offset doesn't seem to save and resets

If the Eddy is calibrated correctly and using special homing macros, a Z-offset may not be needed. The Z-offset parameter adjusts the height at which homing or probing triggers, not the nozzle print height. While direct Z-offset saving might not appear to work as expected with standard probes, performing the Eddy probe calibration correctly should achieve the desired nozzle height. You can simulate a standard Z-offset using the Z-offset beta sample configuration file by uncommenting relevant macros.

7. User Tips

  • Fast Leveling: Users report bed mesh scans on large beds (e.g., 430x430mm) completing in as little as 20 seconds, significantly reducing print start times.
  • High Accuracy: The Eddy series provides high accuracy, with users noting excellent results and improved first layers.
  • Klipper Integration: Klipper support for the Eddy series is continuously improving, offering advanced features for bed leveling.
  • Proper Installation: Pay close attention to the recommended installation height (2-3mm above the nozzle) and ensure the PCB side is away from the hotend to prevent heat transfer.
  • Calibration is Key: Thoroughly perform drive current calibration, nozzle height mapping, and temperature compensation (for Eddy/Eddy Duo) for optimal performance.
  • Check for Conflicts: Be aware of potential conflicts with existing Klipper macros (like KAMP) and adjust your configuration accordingly.

8. Warranty and Support

For further resources, including detailed documentation and community support, please visit the official BIGTREETECH GitHub repository:

https://github.com/bigtreetech/

If you cannot find the information you need or encounter any other problems during use, please contact our after-sales support team:

Email: service005@biqu3d.com

Thank you for choosing BIGTREETECH products.

Ask a question about this manual

Ask about setup, troubleshooting, compatibility, parts, safety, or missing instructions. Manuals+ will review the question and use this page’s manual context to help answer it.

After a successful submission, we securely hash the supplied account or form email before sending it to Microsoft Advertising for conversion attribution. Privacy details.