-
Notifications
You must be signed in to change notification settings - Fork 138
Configuration Reference
The Klipper configuration files for Happy Hare are modular and can be found in this layout in the Klipper config directory (typically ~printer_data/config/
:
mmu/
mmu_vars.cfg
base/
mmu.cfg
mmu_hardware.cfg
mmu_parameters.cfg
mmu_macro_vars.cfg
mmu_software.cfg # READ-ONLY
mmu_sequence.cfg # READ-ONLY
mmu_leds.cfg # READ-ONLY
mmu_form_tip.cfg # READ-ONLY
mmu_cut_tip.cfg # READ-ONLY
mmu_state.cfg # READ-ONLY
optional/
mmu_menu.cfg # READ-ONLY
mmu_ercf_compat.cfg # READ-ONLY
client_macros.cfg # READ-ONLY
addons/
blobifier_hw.cfg
blobifier.cfg # READ-ONLY
mmu_erec_cutter_hw.cfg
mmu_erec_cutter.cfg # READ-ONLY
This makes the minimal include into your printer.cfg easy and guarantees the correct load order!
[include mmu/base/*.cfg]
If you are using optional modules they should appear after the above, for example:
[include mmu/base/*.cfg]
[include mmu/optional/client_macros.cfg]
[include mmu/optional/menu.cfg]
[include mmu/optional/blobifier*.cfg]
Important
Some of the configuration files are marked as READ-ONLY
. These are not designed to be edited by the user - if you desired to change the behavior outside of the built-in extensibility you should copy the logic into macros of your own name and set the options in mmu_parameters.cfg
to point to them instead.
The remainder of the cfg
files are designed to be edited to allow for configuration and customization.
File | Description | Edit? |
---|---|---|
mmu_vars.cfg |
Used to persist state and certain dynamic configuration | |
mmu.cfg |
Configuration for control board (mcu) device location and aliases for control board pins | Yes |
mmu_hardware.cfg |
User adjustable hardware based parameters are stored | Yes |
mmu_parameters.cfg |
Main configuration parameters for the Klipper module | Yes |
mmu_macro_vars.cfg |
Modular config file that controls the operation of all the supplied macros | Yes |
mmu_software.cfg |
Contains core macros leveraged by Happy Hare | |
mmu_sequence.cfg |
Core macros for customization of loading and unload sequences | |
mmu_leds.cfg |
Core macros for controlling LEDs | |
mmu_form_tip.cfg |
Default macros for tip forming logic | |
mmu_cut_tip.cfg |
Default macros toolhead based filament cutting logic | |
mmu_state.cfg |
Default macros for handling state changes | |
mmu_menu.cfg |
Optional config for adding MMU functions to 12864 style displays | |
mmu_ercf_compat.cfg |
Optional config to retain only ERCF sytle command sytax DEPRECATED | |
client_macros.cfg |
Recommended but still optional set of PAUSE/RESUME/CANCEL_PRINT macros | |
blobifier_hw.cfg |
Contains h/w setup options for Blobifier | Yes |
blobifier.cfg |
Default macros for controlling Blobifier blob purging mechanism | |
mmu_erec_cutter_hw.cfg |
Contains h/w setup options for EREC filament cutter | Yes |
mmu_erec_cutter.cfg |
Default macros for controlling ERCF filament cutter |
Now that you understand the layout and purpose of each file, you can follow the links at the top of this wiki for detailed guides on each config file...
(\_/)
( *,*)
(")_(") Happy Hare Ready
Copyright (C) 2022-2024 Paul Morgan
1. Introduction
2. Installation
3. Essential Configuration
4. Calibration
5. Operation
-- YOUR MMU IS READY TO PLAY WITH --
6. Slicer-MMU Setup
-- NOW YOU ARE READY TO PRINT! --
7. Tuning
8. Optional Feature Setup
9. Advanced Configuration
10. Advanced Concepts
- State Persistence
- Statistics and Counters
- Tool and Gate Maps
- Filament Bypass
- Runout/Clog Detection
- Consumption Counters
- Synchronized Gear/Extruder
11. Quick References
12. Troubleshooting
13. FAQ
14. MCU Board Reference 🆕
15. Change Log
Happy Hare Discord