Software Installation

The following instructions assume a recent, clean Kalico or Klipper setup in the default locations similar to what KIAUH sets up: Klipper/Kalico as ~/klipper (or ~/kalico), Python venv in ~/klippy-venv. If this is not true for your setup, you will need to adapt these instructions.

Initial Installation

1. Use git to clone this repository:

cd ~
git clone https://github.com/vvuk/eddy-ng

2. Then run the install script:

cd ~/eddy-ng
./install.sh

(If your Kalico or Klipper isn't installed in ~/klipper, provide the path as the first argument, i.e. ./install.sh ~/my-klipper.)

3. Proceed to device-specific building new firmware, flashing your device, and configuration:

• BTT Eddy
• Cartographer
• Mellow Fly

Updating eddy-ng

Run a git pull and, if running Klipper, re-run the ./install.sh again:

cd ~/eddy-ng
git pull
./install.sh # only if Klipper

After an update, it's best to rebuild and re-flash the firmware as there may be changes.

Updating Kalico or Klipper

Updating Kalico

Update eddy-ng and Kalico independently with "git pull". Because Kalico includes an extension mechanism, eddy-ng does not need to make any changes to the Kalico source and so no reinstallation is necessary after updates.

Updating Klipper

Because Klipper does not have an extension mechanism, the eddy-ng install process needs to make some changes to the Klipper files during installation. You may want to uninstall eddy-ng (the source, not your configuration) from Klipper first before updating, and then re-run the install script after the update. For example:

# uninstall eddy-ng
cd ~/eddy-ng
./install.sh --uninstall
# update Klipper
cd ~/klipper
git pull
# re-install eddy-ng
cd ~/eddy-ng
./install.sh

If you experience problems with updating Klipper via git commands, you can manually clear out eddy-ng changes directly with:

cd ~/klipper
git restore src/Makefile klippy/extras/bed_mesh.py

And then update Klipper. Run install.sh again after updating.

Installing plotly and scipy (highly recommended)

eddy-ng can use the plotly and scipy packages to create graphs that are helpful in diagnosing issues as well as enabling some more advanced configuration. With a standard Klipper installation, this is as simple as:

~/klippy-env/bin/pip3 install plotly scipy

See the Graphs documentation for more information.