Getting Started with Box Turtle¶
This page walks through the first menuconfig pass for a BoxTurtle MMU — the
screens you'll see, in the order you'll see them, and the handful of choices worth
pausing on. It's the first of a set of getting-started pages; other pages cover
toolhead calibration and multi-unit setups in more depth. Here we're just getting
a Box Turtle installed and talking to Klipper.
Menuconfig Installer¶
From your Happy-Hare checkout:
cd ~/Happy-Hare
./install.sh
The very first time you run this, there's no .mmu_config yet, so the installer
drops you straight into menuconfig — no separate flag needed.
This is the installer's default state: MMU Type is Custom Design, the board is
unknown, and the CONFIG WARNINGS / ERRORS panel at the bottom lists exactly
that — four things still need a decision. As soon as you pick a real MMU type,
most of these clear themselves.
A quick word on the controls, since you'll use them constantly:
- Arrow keys move the highlight; Enter (or Space) opens a submenu or toggles/selects the highlighted item.
- Esc or Left Arrow key backs out one level; from the top level it offers to save.
- R resets the highlighted parameter back to its default — useful any time you've typed something and want to back out cleanly without hunting for the original value.
Choosing the MMU type¶
Highlight MMU Type and press Enter:
Move down to Box Turtle and press Space to select it. Two things happen
immediately: the radio button fills in ((X) Box Turtle), and two new lines
appear indented underneath it — Turtle Neck and Design attributes — options
that only make sense once Happy Hare knows this is a Box Turtle.
Enter Turtle Neck to see the buffer choice:
Turtle Neck v2 is already the default — it's the buffer most Box Turtles ship with, sensing both filament tension and compression. If you have the original v1 buffer (unsprung) or something else entirely, change it here; otherwise there's nothing to do and you can back out with Esc or the Left arrow key.
Back out twice (Esc, Esc) to return to the top menu, and look at the warnings panel again:
Three of the four warnings are already gone. The one that's left — "Toolhead type is 'other'" — is exactly what it sounds like: Happy Hare still doesn't know your toolhead, and that's covered in a different getting-started page. Don't worry about it here.
Board type¶
Enter Board type:
Because you already told it this is a Box Turtle, Happy Hare has pre-selected AFC Lite v1.0 / designed for Box Turtle — the board most Box Turtles are built around. If yours is a Box Turtle on a different controller board, this is where you'd pick it instead; the pin defaults for every stepper, sensor and TMC driver on the rest of the menu come from whatever you choose here.
MCU connection¶
Back out to the top and enter MCU connection:
Again, already right for a board like the AFC Lite that plugs in over USB:
MCU connection is Serial, and there's a second line to pick which serial
device if you have more than one board attached. If your board talks CANbus
instead, this is where you'd switch it — but for a stock, USB-attached Box
Turtle, Serial is what you want and there's nothing to change.
MMU Features / Additions¶
Back out and enter MMU Features / Additions:
This is worth a look even though — for a stock Box Turtle — there's nothing to
add. LEDs, eSpooler and the sync-feedback buffer are already switched
on and marked (FIXED), because a Box Turtle always has them; you can't turn them
off here. Fans, an environment sensor, RFID readers, eject buttons and an encoder
are all genuine build options and default off — enable whichever ones you actually
built. If you're following this page for a plain, stock Box Turtle, just look and
move on.
Pins: gear direction¶
This is the one setting on this page that's genuinely impossible to get right by guessing. Back out to the top, enter Pins / TMC, then Gear pins:
Every gate has its own UART, step, dir, enable and diag pin, all filled in from the AFC Lite defaults you picked earlier. The one you're most likely to need to touch is dir — whether a gear stepper spins the "right" way depends on which way its cable happens to be plugged in, and no config file can know that in advance. You'll find out the first time you try to load filament and gate 0 (say) runs backwards.
Highlight Gear dir pin and press Enter to open its editor:
If that gear needs reversing, add a ! in front of the pin name — Klipper's
standard way of inverting a pin's polarity:
That's it — no rewiring, no .cfg files to hand-edit. Press Enter to accept the
change, or Esc to back out without applying it. And if you ever change a value
here and decide you'd rather have the default back, that's exactly what the R
key mentioned earlier is for: highlight the parameter and press R, and it resets
to whatever Happy Hare would have picked on its own.
Picking a toolhead¶
From the top menu, enter Toolhead:
This step is entirely optional — skip it and Happy Hare falls back to generic "Other/Unknown" dimensions, which is a perfectly normal starting point. But if your toolhead (extruder + hotend combo) happens to be in this list, picking it gets you real, community-measured values instead of guesses, for free. Here we've picked Stealthburner Clockwork2 Revo Voron at random, just to show what selecting one does.
Back out and enter Toolhead sensors/settings to see the effect:
Extruder entrance to nozzle and Residual filament, under Toolhead dimensions,
are already filled in — 85.1 and 2 here — measured by someone else on the same
hardware rather than left at the generic default. The other two distances Happy Hare
can use (toolhead sensor to nozzle, extruder sensor to entry) only appear once you've
told it you actually have those sensors on your toolhead, higher up this same screen --
until relevent the values stay hidden here.
This is a shortcut, not a substitute: even with a listed toolhead, you're still
better off learning to measure and calibrate your own eventually, since small
build variations and mods add up. But it's a genuinely good starting point,
and if your exact combo isn't listed, "Other/Unknown" plus manual calibration
(MMU_CALIBRATE_TOOLHEAD) is exactly as normal a path as this one.
An example software option: Spoolman¶
From the top menu, enter Software Options, then Select spoolman spool manager support:
This is one small example of the many software-side options living under Software Options — most of them, like this one, default to off and are entirely optional. If you run a Spoolman instance and just want Happy Hare to pull filament details (material, color, temperatures) onto each gate without pushing anything back, select Read-only as shown here. The help table on screen lays out exactly what each of the four modes does — off, read-only, push, and pull — so you can pick the one that matches how you actually use Spoolman.
Notice the row now reads (Read-only) (NOT DEFAULT) — menuconfig always flags a
value that differs from its default this way, which makes it easy to spot your
own changes later. If you decide you don't want it after all, R puts it straight
back to Off.
Explore the rest¶
That's enough to get a stock Box Turtle basically talking to Klipper, but it's
only a fraction of the menu. Software Options, Tip Forming / Cutting,
Purging, Endstops and Bowden movement and the rest are all worth a look —
scroll all the way from the top to Paths & Services at the bottom at least
once. Nothing you look at will break anything: moving the highlight
costs nothing, and R is always there to undo a change you don't
want. Remember that you don't need to setup everything now — you can come back
many times and re-run menconfig with ./install.sh -i and incrementally
setup features and macros.
Saving, and coming back later¶
When you're done, press Esc from the top level (or Q) to get the save
prompt, and confirm. Happy Hare writes your .cfg files from what you chose.
The installer only forces menuconfig open automatically on that very first run.
After that, running ./install.sh again just upgrades in place — it won't reopen
the menu. To go back in and change something, use:
cd ~/Happy-Hare
./install.sh -i
This is the normal way to revisit any setting on this page — there's no need to
ever hand-edit the generated .cfg files directly.
Note
The one thing worth knowing:
if you've hand-edited a .cfg file since your last visit to menuconfig,
-i will ask how to reconcile that — Refresh (keep your manual edits, and
just add new options), Replace (regenerate everything from menuconfig, discarding
direct edits) or Merge (attempts to merge manual edits into menuconfig)
If you only ever configure through menuconfig, as this page assumes, option 2
(Refresh) is the recommended choice because it rebuilds your Happy Hare
klipper config files ensuring a clean config and any future update made to the
Happy Hare sofware.
Validating Hardware Setup¶
The shared Hardware Validation checklist covers the MCU, selector variants, encoder and the movement/homing model in full. The checks below call out the Box Turtle hardware specifically.
With Klipper accepting the config and no startup errors, confirm the physical mechanism actually does what Happy Hare thinks it does before calibrating anything or trying to print.
Gear stepper direction. Each gate has its own gear stepper, and which way it spins depends entirely on how its motor cable happens to be plugged in. Check each one — feed a scrap of filament in by hand first so you can see which way it moves:
MMU_SELECT GATE=0
MMU_TEST_MOVE MOVE=50
It should feed forward, away from the spool. If a gate runs backward,
give that gate's Gear dir pin a ! (see Pins: gear
direction above) and try again. Repeat with
GATE=1, GATE=2, GATE=3.
Sensors. Insert a short fragment of filament into a gate's entry by hand and check it registers:
MMU_SENSORS
mmu_entry_0 --> TRIGGERED
mmu_entry_1 --> Open
filament_compression --> Open
filament_tension --> Open
Remove the fragment and confirm it goes back to Open. Do this for every
gate you plan to use, not just the first — a per-gate sensor is exactly
as likely to be miswired as a gear direction pin.
Sync-feedback buffer orientation. A Turtle Neck buffer trips people up here, because the mapping isn't the one you'd guess: filament under compression (excess being fed in) makes the buffer extend; filament under tension (being pulled taut, not enough slack) makes it fully compress. Centered, at rest, it should read neutral. Move the shuttle by hand to each extreme and confirm:
MMU_SYNC_FEEDBACK
Sync feedback: Neutral
If compression and tension read backward from what you expect, swap
compression_pin/tension_pin in mmu_hardware.cfg (or their inversions)
rather than second-guessing the mechanism.
eSpooler. With filament at the gate, confirm the motor spins the right way for both directions:
MMU_ESPOOLER GATE=0 BURST=1 OPERATION=rewind
MMU_ESPOOLER GATE=0 BURST=1 OPERATION=assist
rewind should take up slack onto the spool; assist should feed
filament off it. If either runs backward, invert that gate's espooler
motor pin the same way as the gear direction fix above.
Calibration¶
A Box Turtle doesn't need much here. Bowden length is auto-calibrated on
first load by default (autocal_bowden_length, on for the Turtle Neck v2
buffer this guide assumes), so there's nothing to run by hand for that.
The one step worth doing anyway is calibrating each gate/lane's gear
stepper for an accurate rotation_distance:
MMU_CALIBRATE_GEAR MEASURED=102.5
It isn't forced — Happy Hare will run on the installed default regardless — but it's genuinely worth the few minutes per gate for accurate filament changes and fewer load/unload errors down the line. See Calibration for the full picture (which steps apply to which MMU type, and why) and Calibration: Gear Rotation Distance for the complete procedure.
Checking Basic Operation¶
Outside of a print, confirm the basics work end to end on a gate you've already validated above:
MMU_SELECT GATE=0
MMU_LOAD
MMU_UNLOAD
Each should complete without error — no pauses, no "not calibrated" warnings you weren't expecting. If something goes wrong here, it's much easier to diagnose now than mid-print; see Operation: Debugging Problems if any of it doesn't behave as expected.
Slicer Setup¶
You now need to add some gcode hooks into your favorate slicer for start g-code,
end g-code, after layer change and on tool change. This is to coordinate with
the MMU during certain phases of a print. This is covered in
Slicer Setup. Jump to this section, make these
changes and return here.
Printing with MMU¶
Besides the slicer gcode hooks above, there's one real decision left before your first multi-material print: how purging between colors happens.
- Slicer-controlled — your slicer's own wipe tower, printed alongside the model. Simplest to set up; costs bed space and filament.
- Happy Hare-controlled — a dedicated purge macro runs at each toolchange instead of a wipe tower: either Macro: Purge (simple, prints a purge line) or Macro: Blobifier (a dedicated purge/park station, more capable but its own hardware). See Purging without a wipe tower for how to disable the slicer's tower and hand purging over to Happy Hare.
Either way, the toolchange parking positions and movement (retraction,
z-hop, where the toolhead parks during a change) live in
mmu_macro_vars.cfg, tunable through Macro Variables in menuconfig
— see Toolchange Movement for what each setting
actually does before changing the defaults.
Once that's decided, slice something with more than one filament and run your first print.
What Next?¶
- Install KlipperScreen (Happy Hare edition) if you want a touchscreen front end, or drive everything from Mainsail / Fluidd — either works, and both are covered.
- From here, explore the rest of this site's Features section one page at a time as you actually need them — Spoolman integration, NFC/RFID tags, EndlessSpool, and the rest. Trying to absorb all of it before your first print is the fastest way to feel overwhelmed by an MMU that, day to day, mostly just works.