Btteddy

Eddy NG¶

I strongly recommend you try the Eddy NG instead of this implementation, it has TAP functionality like Cartographer and Beacon.

Where can I get help?¶

Come on over to the pellcorp discord server, the #simple-af-btteddy channel has been setup for anyone wanting support for btt eddy.

Firmware requirements¶

This guide assumes you have a K1, K1C or K1 Max and you are running stock creality firmware 1.3.3.5 or higher, or alternately you are using my prerooted firmware. Any other pre-rooted firmware is explicitly not supported and the installer.sh will validate this and refuse to proceed if you try to use it on different firmware.

Slicer Settings¶

There is an assumption that you are using a slicer like OrcaSlicer and Machine G-code like:

Machine start G-code

M140 S0
M104 S0
START_PRINT EXTRUDER_TEMP=[nozzle_temperature_initial_layer] BED_TEMP=[bed_temperature_initial_layer_single]

Machine end G-code

END_PRINT

Custom Bed Mesh Profile¶

If you want to select a specific predefined bed mesh profile (which disables adaptive mesh generation), you can pass in an additional START_PRINT parameter:

You can either hard code it to a particular model, like BED_MESH_PROFILE=myprofile or you can specify a profile based on orca slicer variables, such as BED_MESH_PROFILE="[curr_bed_type] - [filament_type]", but you have to make sure you have all the possible profiles defined for each of the bed type and filament type combinations.

Probe Installation¶

Danger

Please note if you are not using ZeroDotCmd side mount you might have to make post install config changes to btteddy.cfg and btteddy-k1.cfg or btteddy-k1m.cfg before homing your printer, using screw tilt adjust or doing a bed mesh! Ignoring these instructions can lead to significant damage to your build plate and/or probe.

Ignoring these instructions can lead to significant damage to your build plate and/or probe.

Mount Options¶

Mount	URL	Notes
Default	https://www.printables.com/model/1012524-btteddy-creality-k1-k1c-k1-max-mount
Pellcorp	https://www.printables.com/model/965667-wip-k1-btt-eddy-rear-mount-v4
Ballaswag	https://makerworld.com/en/models/494931	Config copied from k1_mod sources, otherwise not tested
Slam	https://www.printables.com/model/1195575-btt-eddy-mount-for-k1c

Nozzle Offset¶

Warn

If you use a different probe mount you must make sure the bottom of the btt eddy is between 2.5mm and 3mm from the tip of the nozzle, so if the nozzle is touching the bed (when both are cold), the bottom of the eddy should be at least 2.5mm above the bed and no more than 3mm.

K1M vs K1/K1C/K1SE¶

Info

On a K1M you can use the lidar cable either directly by repinning it, or via the pass through lidar port on the toolhead. However you cannot use the lidar port on the toolhead for K1, K1C or K1SE. The reason this does not work is because for Lidar on the K1M creality actually routes a completely separate USB cable from the mainboard.

BTT Eddy Firmware¶

Warning

It is assumed that you have flashed your eddy with the firmware from https://github.com/pellcorp/klipper/blob/master/fw/K1/btteddy.uf2 before starting the installation!!!

I have put together a guide for flashing the btt eddy here

Installation¶

The installation can only be performed on a printer which has been rooted and ssh granted

You need root access, if you are not already root, then follow the excellent Helper Script Enable Root Access instructions.

Tip

ZeroDotCmd (aka Zero on discord) has provided an excellent BTT Eddy installation video, you can find it https://www.youtube.com/watch?v=B17sS1klRxA

Factory Reset¶

You must do a factory reset before running the installer.sh. Follow these steps to do a factory reset, which retains root access and skips the startup calibration checks:

wget --no-check-certificate  https://raw.githubusercontent.com/pellcorp/creality/main/k1/services/S58factoryreset
chmod +x S58factoryreset
./S58factoryreset reset

Warn

It is really important you do not close the ssh session until you get this message:

Clone the Repo¶

git config --global http.sslVerify false
git clone https://github.com/pellcorp/creality.git /usr/data/pellcorp
sync

RPC Timeouts, try SSH Git Clone

mkdir -p /root/.ssh
wget --no-check-certificate "https://raw.githubusercontent.com/pellcorp/creality/main/k1/ssh/git-ssh.sh" -O /root/git-ssh.sh
chmod 777 /root/git-ssh.sh
wget --no-check-certificate "https://raw.githubusercontent.com/pellcorp/creality/main/k1/ssh/pellcorp-identity" -O /root/.ssh/pellcorp-identity
export GIT_SSH_IDENTITY=pellcorp
export GIT_SSH=/root/git-ssh.sh
git clone git@github.com:pellcorp/creality.git /usr/data/pellcorp
cd /usr/data/pellcorp && git remote set-url origin https://github.com/pellcorp/creality.git && cd

Config Overrides¶

If you have pellcorp-overrides in github but not stored locally, you need to recreate the /usr/data/pellcorp-overrides directory before running the installer.sh!

Run the installer¶

To run the script, you must specify the probe you want to use.

/usr/data/pellcorp/k1/installer.sh --install btteddy --mount Mount

Warning

For Mount you must specify the mount option for the mount you have used, if you do not do this the printer will be incorrectly configured for your mount, and bed meshes, x and y limits and related config will be wrong. Please refer to Mount Options for supported mounts.

If you are using a non-supported mount you should specify a mount option as close to your mount as possible and properly adjust your configuration after installation before trying to perform a bed mesh or Screws Tilt Calculate!

RPC failed; curl 18 transfer closed

You might get this error:

error: RPC failed; curl 18 transfer closed with outstanding read data remaining
fatal: the remote end hung up unexpectedly
fatal: early EOF
fatal: index-pack failed

Just rerun the installer.sh script (with the same probe argument), it will start from the stage that failed (most of the time this will be the Installing Klipper stage!)

You can also prefix the installer command with AF_GIT_CLONE=ssh to force git to clone via ssh, this will take a lot longer, but it will never time out, so its good in a pinch if you are getting repeated klipper repo clone failures.

Post Installation¶

MCU Firmware updates are pending¶

At the end of the installer process if you get this message:

WARNING: MCU Firmware updates are pending you need to power cycle your printer!

It means that new MCU firmware updates need to be applied and this can only be done by power cycling the printer. After your printer is power cycled you can verify firmware was updated with the CHECK_FIRMWARE macro from Fluidd or Mainsail, if you see this message:

INFO: Your MCU Firmware is up to date!

Your printer MCU firmware was updated successfully. If you still see the MCU Firmware updates are pending you need to power cycle your printer! message after a power cycle, check the /tmp/mcu_update.log, you may be asked to provide this file on Discord if you need additional assistance, sometimes an additional power cycle can solve the problem, there is a very short window of time (15 seconds) in which the MCU firmware can be updated, so there is a chance it will work after an additional power cycle.

Verify USB Key¶

Tip

You should verify your USB thumb drive (aka USB Key) often just to make sure you have something if you need to unbrick your printer, simply type CHECK_USB_KEY or hit the button in Fluidd / Mainsail

Note

If you have plugged your btt eddy into the front usb port, you are going to have to temporarily remove the btt eddy from the front usb slot and replace it with your USB thumb drive, after you have finished verifying the USB thumb drive can be used in an emergency, you can replace the btt eddy into the front usb slot and restart klipper or power cycle your printer.

It is important to make sure you have a way to emergency factory reset the printer, if the worst happens. There is a macro in Simple AF called CHECK_USB_KEY that will wait for you to plug a USB thumb drive (aka USB key) in and tell you if it was able to be successfully mounted.

If you get the message: INFO - USB Key was recognised and mounted correctly (/tmp/udisk/sda1), your USB thumb drive (aka USB key) is perfect to use for a factory reset.
If you get no message at all before the script ends (after 60 seconds), your USB thumb drive (aka USB key) is defective. You can check the messages file in the logs section of your UI to get more details about why the usb key could not be mounted!

Troubleshooting¶

Manual BTT Eddy Serial Device configuration¶

You can run the following command to fix your serial if you forgot to plug your btt eddy in during the installation or update:

/usr/data/pellcorp/k1/installer.sh --fix-serial

Calibration¶

Danger

It is extremely important that you perform the following calibrations while the btt eddy is cool, if you calibrate the eddy hot, you will experience Error during homing z: Eddy current sensor error errors while homing and performing bed mesh if the btt is significantly cooler than it was while doing initial calibration.

Note

The BTTEDDY_CALIBRATE_DRIVE_CURRENT, BTTEDDY_CURRENT_CALIBRATE and BTTEDDY_TEMPERATURE_PROBE_CALIBRATE macros will turn on the auxiliary fan until the btt eddy temp is less than 40c before starting the actual calibration. If you are in a hot climate you may need to adjust the btteddy_macro.cfg variable_calibration_max_temp value to something higher than 40c if you can't get the btt eddy under 40c with the aux fan easily.

Drive Current Calibration¶

Home XY (G28 X Y)
Make sure nozzle is centred on bed
Run _SET_KIN_MAX_Z and then move the toolhead so that the bottom of the eddy is 20mm from the bed, please try and be as accurate as possible with this distance, it's better to be slightly closer to the bed than further away.
Run BTTEDDY_CALIBRATE_DRIVE_CURRENT
Run SAVE_CONFIG

Source: https://github.com/bigtreetech/Eddy?tab=readme-ov-file#2-drive-current-calibration

Mapping Eddy Readings To Nozzle Heights¶

Home X and Y (G28 X Y)
Make sure nozzle is centred on bed
Run BTTEDDY_CURRENT_CALIBRATE Follow the Paper Test Method
Upon completion SAVE_CONFIG

Note

Is normal to show the Z position at almost at the max height of the printer even if the nozzle is somewhere in the middle or even close to the bed, this is not a bug, its intentional. Until this calibration step is completed, the Z axes cannot be homed, so we make the printer pretend the bed is down the bottom of the printer so that you can freely move the bed up to meet the nozzle during the paper test without running into out of range issues. You however won't be able to move the bed further away from the nozzle more than a few mm.

Warning

Do not use a metal feeler gauge for this step, it could interfere with calibration!!!

Source: https://github.com/bigtreetech/Eddy?tab=readme-ov-file#3-mapping-eddy-readings-to-nozzle-heights

Temperature Compensation Calibration¶

Home All (G28)
Make sure nozzle is centred on bed
Run BTTEDDY_TEMPERATURE_PROBE_CALIBRATE
Upon completion SAVE_CONFIG

Warning

Do not use a metal feeler gauge for this step, it could interfere with calibration!!!

Tip

If you are struggling to get over about 80c, you can end the calibration early with the TEMPERATURE_PROBE_COMPLETE macro, just know that if you end the calibration early and then you try to print really hot and the eddy gets hotted than the hottest temp you calibrated the eddy is going to read the bed wrong and cause issues for homing but especially bed meshes.

Source: https://github.com/bigtreetech/Eddy?tab=readme-ov-file#5-temperature-compensation-calibration-eddy-usb-only

Axis Twist Compensation¶

If you are using a rear mount it is highly recommended to perform axis twist compensation, this will affect the quality of your bed mesh, so best to do it before.

Tip

There is no need to run axis twist compensation if you have mounted the eddy with a side mount that has a 0 y offset!

Home All (G28)
Run AXIS_TWIST_COMPENSATION_CALIBRATE The calibration wizard will prompt you to measure the probe Z offset at a few points along the bed
Upon completion SAVE_CONFIG

Warning

Do not use a metal feeler gauge for this step, it could interfere with calibration!!!

Source: https://www.klipper3d.org/Axis_Twist_Compensation.html

First Print¶

For this first print you can go and do the tuning first (PID Tuning, etc) or you can go ahead and optimise your z_offset. Note you would think that the z_offset in [probe_eddy_current btt_eddy] would allow you to adjust the z offset for a nice first layer, but it seems like the z_offset does not work that way for btt eddy, so we are using the save-zoffset hack originally from Helper Script for btt eddy until such time as the z_offset does actually work correctly.

Bed Mesh¶

Now you can now run your first bed mesh: BED_MESH_CALIBRATE

Source: https://ballaswag.github.io/blog/creality-k1-btt-eddy-guide/

Source: https://github.com/bigtreetech/Eddy

Error during homing z: Eddy current sensor error¶

You might need to adjust your reg_drive_current, for more details: https://github.com/bigtreetech/Eddy?tab=readme-ov-file#sometimes-i-get-error-during-homing-probe-eddy-current-sensor-error

Tuning¶

At least PID tuning (bed and extruder) and input shaping is required for acceptable printing. If you try and print after running the installer.sh and a power cycle but before any calibration you will most likely have horrendous quality, the worst you have ever seen on the k1. After PID tuning and input shaping you should see the same kind of quality as you get with stock k1 + input shaper fix.

Quick Start¶

You can use the QUICK_START Macro to do Bed and Nozzle PID Tuning and Input Shaping.

Pid Tuning¶

Source: Calibrate Pid Settings

For example you might run these:

PID_CALIBRATE_BED BED_TEMP=65
PID_CALIBRATE_HOTEND HOTEND_TEMP=230

Note

The PID_CALIBRATE_BED and PID_CALIBRATE_HOTEND macros are located in the useful_macros.cfg file and they have defaults values for BED_TEMP and HOTEND_TEMP so you can just run them by clicking on them if you want that same temperature.

Input Shaping¶

There is no default configuration for input shaping so it is essentially disabled out of the box.

You can use the SHAPER_CALIBRATE macro to run input shaping, just be sure to SAVE CONFIG at the end, to choose the automatically selected shaper config, be aware though that the shaper chosen might be sub-optimal due to a slight difference in vibrations between two options. So you should probably review the output and potentially choose an alternative if it gives you higher recommended max acceleration for minimal increase in vibration.

Input Shaper Auto Calibration

Other Calibrations¶

Info

The default value for pressure advance is set to 0.04

Refer to Orcaslicer Calibration for more calibrations

Refer to the Ellis Print Tuning Guide for more great tuning ideas.