Printer Variables

Happy Hare Added Printer Variables and Events

Happy Hare exposes 'printer' variables that can be used in your own macros.

    printer.mmu.enabled : {bool} True if MMU is enabled
    printer.mmu.num_gates : {int} number of gates configured
    printer.mmu.is_paused : {bool} True if MMU is paused after an error (can also use print_job_state)
    printer.mmu.is_locked : {bool} DEPRECATED, use for printer.mmu.is_paused instead
    printer.mmu.is_homed : {bool} True if MMU has been homed
    printer.mmu.is_in_print : {bool} True if MMU is managing a print job (print_job_state is printing|pause_locked|paused)
    printer.mmu.tool : {int} 0..n | -1 for unknown | -2 for bypass
    printer.mmu.gate : {int} 0..n | -1 for unknown
    printer.mmu.active_filament : {dict} of active filament attributes (from gate_map, e.g. active_filament.material, active_filament.color)
    printer.mmu.last_tool : {int} 0..n | -1 for unknown | -2 for bypass (during a tool change after unload)
    printer.mmu.next_tool : {int} 0..n | -1 for unknown | -2 for bypass (during a tool change)
    printer.mmu.toolchange_purge_volume : {float} suggested purge volume for current toolchange (mm^3)
    printer.mmu.last_toolchange : {string} description of last change similar to M117 display
    printer.mmu.runout : {bool} DEPRECATED, use printer.mmu.operation == "runout" instead
    printer.mmu.operation : {string} Operation in progress (toolchange, load, unload, runout, pause, cancel, complete)
    printer.mmu.filament : {string} filament state in extruder (Loaded | Unloaded | Unknown)
    printer.mmu.filament_position : {float} location in mm of filament
    printer.mmu.filament_pos : {int} state machine - exact location of filament
    printer.mmu.filament_direction : {int} 1 (load) | -1 (unload)
    printer.mmu.servo : {string} Up | Down | Move | Unknown (exists only if MMU has servo)
    printer.mmu.ttg_map : {list} defined gate for each tool
    printer.mmu.gate_status : {list} per gate: 0 empty | 1 available | 2 available from buffer |  -1 unknown
    printer.mmu.gate_name : {list} of filament names, one per gate
    printer.mmu.gate_material : {list} of material names, one per gate
    printer.mmu.gate_color : {list} of color names, one per gate
    printer.mmu.gate_temperature : {list} of filament temperatures, one per gate
    printer.mmu.gate_color_rgb : {list} of color rbg values from 0.0 - 1.0 in truples (red, green blue), one per gate
    printer.mmu.gate_spool_id : {list} of IDs for Spoolman, one per gate
    printer.mmu.custom_color_rgb : {list} of color rbg values from 0.0 - 1.0 in truples (red, green blue), one per gate
    printer.mmu.slicer_tool_map : {dict} of slicer defined tool attributes (in form slicer_tool_map.tools.x.[color|material|temp|in_use])
    printer.mmu.endless_spool_groups : {list} membership group (int) for each tool
    printer.mmu.tool_extrusion_multipliers : {list} current M221 extrusion multipliers (float), one per tool
    printer.mmu.tool_speed_multipliers : {list} current M220 extrusion multipliers (float), one per tool
    printer.mmu.action : {string} Idle | Loading | Unloading | Forming Tip | Heating | Loading Ext | Exiting Ext | Checking | Homing | Selecting
    printer.mmu.has_bypass : {bool} True if available else False
    printer.mmu.synced_drive : {bool} True if gear stepper is currently synced to extruder
    printer.mmu.sync_feedback_state : {string} State of sync feedback sensor (compressed | expanded | neutral | disabled)
    printer.mmu.print_job_state : {string} current job state seen by MMU (initialized | standby | started | printing | pause_locked | paused | complete | cancelled | error)
    printer.mmu.clog_detection : {int} 0 (off) | 1 (manual) | 2 (auto)
    printer.mmu.endless_spool : {int} 0 (disabled) | 1 (enabled) | 2 (additionally enabled for pre-gate sensor)
    printer.mmu.print_start_detection : {int} 0 (disabled) | 1 (enabled) For Klippain
    printer.mmu.reason_for_pause : {string} 
    printer.mmu.extruder_filament_remaining : {float} amount of residual + cut filament left in the extruder (for toolchange macros)
    printer.mmu.enable_spoolman : {int} 0 (disabled) | 1 (enabled) DEPRECATED, use printer.mmu.spoolman_support instead
    printer.mmu.spoolman_support: {string} spoolman integration mode (off | readonly | push | pull)
    printer.mmu.selector_type: {string} style of MMU selector (VirtualSelector | LinearSelector)

Optionally exposed for mmu_encoder (if fitted):

    printer['mmu_encoder mmu_encoder'].encoder_pos : {float} Encoder position measurement in mm
    printer['mmu_encoder mmu_encoder'].detection_length : {float} The detection length for clog detection
    printer['mmu_encoder mmu_encoder'].min_headroom : {float} How close clog detection was from firing on current tool change
    printer['mmu_encoder mmu_encoder'].headroom : {float} Current headroom of clog detection (i.e. distance from trigger point)
    printer['mmu_encoder mmu_encoder'].desired_headroom : {float} Desired headroom (mm) for automatic clog detection
    printer['mmu_encoder mmu_encoder'].detection_mode : {int} Same as printer.mmu.clog_detection
    printer['mmu_encoder mmu_encoder'].enabled : {bool} Whether encoder is currently enabled for clog detection
    printer['mmu_encoder mmu_encoder'].flow_rate : {int} % flowrate (extruder movement compared to encoder movement)

Klipper Events

If you are a developer you might be interested in the following klipper events that are generated by Happy Hare:

Event Name         Parameters            Description
----------         ----------            -----------
mmu:mmu_paused     -                     Called when mmu_error occurs
mmu:mmu_resumed    -                     Called when print is resumed after mmu_error
mmu:enabled        -                     When MMU is enabled, e.g. with MMU ENABLE=1
mmu:disabled       -                     When MMU is disabled, e.g. with MMU ENABLE=0
mmu:toolchange     last_tool, next_tool  When tool change is initiated (start of)
mmu:synced         -                     When filament driver (gear stepper) is synced to extruder
mmu:unsynced       -                     When filament driver (gear stepper) is synced to extruder

Happy Hare also listens for sync_feedback events. These can be generated internally with built in sync feedback support, but can also be used to keep gear/extruder motors in sync using a third party feedback device:

mmu:sync_feedback  state                 The state is a float between -1.0 and +1.0 and represents
                                         the state of tension (negative value) or compression (positive
                                         value) of the filament inside the bowden. A value of 0 is neutral