Quick Start BoxTurtle

BoxTurtle Quickstart

Page Sections:

• Cloning Happy Hare Repo
• Running Beta Installer
• Selecting your Configuration

This quickstart guide explains how to install Happy Hare firmware for use with the BoxTurtle modular multimaterial system.

Important

BoxTurtle support is currently in a beta state.

Terminology

The terminology for BoxTurtle and HappyHare differ a bit. Terms map as follows:

BoxTurtle Term	Happy Hare Term
Lane/Leg	Gate
Trigger	Pre-gate sensor
AFC Stepper	Gear stepper
Load sensor	Gear sensor
Hub sensor	Gate sensor
Tool start sensor	Extruder sensor
Tool end sensor	Toolhead sensor

Cloning Happy Hare Repo

First, download the Happy Hare repository onto your Raspberry Pi using the git tool. Log into your Raspberry Pi via SSH (PuTTy on Windows):

ssh pi@klippy.local

Note

Replace klippy.local with your Raspberry Pi's hostname. If you use a different username than pi, replace pi with your custom username.

Now, clone the Happy Hare repository onto your Raspberry Pi:

cd ~
git clone https://github.com/moggieuk/Happy-Hare.git

Happy Hare is now downloaded onto your Raspberry Pi. The next step is installing it.

Running Beta Installer

To install Happy Hare firmware, run the following commands on your Raspberry Pi through SSH:

cd ~/Happy-Hare
./install.sh -i -b v3beta

This will open the interactive installer. You will be presented by several options, each of which are explained below.

1. MMU Type

This is the type of MMU you are setting up. In this case, it is a BoxTurtle v1.0. Find it in the list, and type the number located next to it.

2. Number of Gates

The installer will then ask for the number of gates you have. This corresponds to how many filament units you have set up on your BoxTurtle. Type the number and press enter.

Note

In the screenshot below, four lanes are present, so the number 4 is entered.

3. Control Board

Next, the installer will ask which controller you are using. If your controller is in the list, type the number next to its name in the list, and press enter. Typical boards used with BoxTurtle are the MMB boards or AFC Lite. If not, press the number next to Not in list / Unknown.

4. Serial Port

The installer will attempt to locate the serial port of your selected control board. If the displayed port is correct, type y and press enter. If not, type n and press enter.

Tip

If you're unsure about the serial port, open a new SSH window, unplug your controller board, and run:

ls /dev/serial/by-id

Next, plug in your controller board, and re-run the command. The newly added line is your controller's serial address.

5. LEDs

Choose whether or not you want LEDs enabled for your BoxTurtle.

6. EndlessSpool

Choose whether or not you want Endless Spool to be enabled. This let Happy Hare automatically load another spool if your current spool runs out.

7. printer.cfg

This is usually set to y on new Happy Hare installations, and n on existing ones.

8. mmu.cfg

Review the pin aliases in your mmu/base/mmu.cfg to ensure they are correct. The pin aliases for the AFC Lite board should match up with the ones used by the official AFC software. If using MMB, they may be a little different.

9. mmu_hardware.cfg

Review the generated mmu/base/mmu_hardware.cfg to ensure things like:

• Stepper direction pins are correct, inverting if necessary (adding/removing ! as necessary).
• Configure LEDs
  • Standard BoxTurtle should set chain_count: 4
  • Set exit_range: 1-4
  • Remove entry_range and status_index

9. mmu_parameters.cfg

...

10. dc_espooler_hw.cfg

Review mmu/addons/dc_espooler_hw.cfg.

• Each lane should be configured with a rwd pin. Depending on your hardware you may need to turn off pwm and scale.
• You can also configure an en pin if needed (AFC Lite boards use the enable pin).

---

🎉 Happy Hare is successfully installed!

(Quick start guide based on the 3MS template by 3DCoded)