22 KiB

Raw Blame History

Status reference

This document is a reference of printer status information available in Klipper macros, display fields, and via the API Server.

The fields in this document are subject to change - if using an attribute be sure to review the Config Changes document when upgrading the Klipper software.

angle

The following information is available in angle some_name objects:

temperature: The last temperature reading (in Celsius) from a tle5012b magnetic hall sensor. This value is only available if the angle sensor is a tle5012b chip and if measurements are in progress (otherwise it reports None).

bed_mesh

The following information is available in the bed_mesh object:

profile_name, mesh_min, mesh_max, probed_matrix, mesh_matrix: Information on the currently active bed_mesh.
profiles: The set of currently defined profiles as setup using BED_MESH_PROFILE.

bed_screws

The following information is available in the Config_Reference.md#bed_screws object:

is_active: Returns True if the bed screws adjustment tool is currently active.
state: The bed screws adjustment tool state. It is one of the following strings: "adjust", "fine".
current_screw: The index for the current screw being adjusted.
accepted_screws: The number of accepted screws.

configfile

The following information is available in the configfile object (this object is always available):

settings.<section>.<option>: Returns the given config file setting (or default value) during the last software start or restart. (Any settings changed at run-time will not be reflected here.)
config.<section>.<option>: Returns the given raw config file setting as read by Klipper during the last software start or restart. (Any settings changed at run-time will not be reflected here.) All values are returned as strings.
save_config_pending: Returns true if there are updates that a SAVE_CONFIG command may persist to disk.
save_config_pending_items: Contains the sections and options that were changed and would be persisted by a SAVE_CONFIG.
warnings: A list of warnings about config options. Each entry in the list will be a dictionary containing a type and message field (both strings). Additional fields may be available depending on the type of warning.

display_status

The following information is available in the display_status object (this object is automatically available if a display config section is defined):

progress: The progress value of the last M73 G-Code command (or virtual_sdcard.progress if no recent M73 received).
message: The message contained in the last M117 G-Code command.

endstop_phase

The following information is available in the endstop_phase object:

last_home.<stepper name>.phase: The phase of the stepper motor at the end of the last home attempt.
last_home.<stepper name>.phases: The total number of phases available on the stepper motor.
last_home.<stepper name>.mcu_position: The position (as tracked by the micro-controller) of the stepper motor at the end of the last home attempt. The position is the total number of steps taken in a forward direction minus the total number of steps taken in the reverse direction since the micro-controller was last restarted.

exclude_object

The following information is available in the exclude_object object:

objects: An array of the known objects as provided by the EXCLUDE_OBJECT_DEFINE command. This is the same information provided by the EXCLUDE_OBJECT VERBOSE=1 command. The center and polygon fields will only be present if provided in the original EXCLUDE_OBJECT_DEFINE

Here is a JSON sample:

[
  {
    "polygon": [
      [ 156.25, 146.2511675 ],
      [ 156.25, 153.7488325 ],
      [ 163.75, 153.7488325 ],
      [ 163.75, 146.2511675 ]
    ],
    "name": "CYLINDER_2_STL_ID_2_COPY_0",
    "center": [ 160, 150 ]
  },
  {
    "polygon": [
      [ 146.25, 146.2511675 ],
      [ 146.25, 153.7488325 ],
      [ 153.75, 153.7488325 ],
      [ 153.75, 146.2511675 ]
    ],
    "name": "CYLINDER_2_STL_ID_1_COPY_0",
    "center": [ 150, 150 ]
  }
]

excluded_objects: An array of strings listing the names of excluded objects.
current_object: The name of the object currently being printed.

extruder_stepper

The following information is available for extruder_stepper objects (as well as extruder objects):

pressure_advance: The current pressure advance value.
smooth_time: The current pressure advance smooth time.
motion_queue: The name of the extruder that this extruder stepper is currently synchronized to. This is reported as None if the extruder stepper is not currently associated with an extruder.

fan

The following information is available in fan, heater_fan some_name and controller_fan some_name objects:

speed: The fan speed as a float between 0.0 and 1.0.
rpm: The measured fan speed in rotations per minute if the fan has a tachometer_pin defined.

filament_switch_sensor

The following information is available in filament_switch_sensor some_name objects:

enabled: Returns True if the switch sensor is currently enabled.
filament_detected: Returns True if the sensor is in a triggered state.

filament_motion_sensor

The following information is available in filament_motion_sensor some_name objects:

enabled: Returns True if the motion sensor is currently enabled.
filament_detected: Returns True if the sensor is in a triggered state.

firmware_retraction

The following information is available in the firmware_retraction object:

retract_length, retract_speed, unretract_extra_length, unretract_speed: The current settings for the firmware_retraction module. These settings may differ from the config file if a SET_RETRACTION command alters them.

gcode_button

The following information is available in gcode_button some_name objects:

state: The current button state returned as "PRESSED" or "RELEASED"

gcode_macro

The following information is available in gcode_macro some_name objects:

<variable>: The current value of a gcode_macro variable.

gcode_move

The following information is available in the gcode_move object (this object is always available):

gcode_position: The current position of the toolhead relative to the current G-Code origin. That is, positions that one might directly send to a G1 command. It is possible to access the x, y, z, and e components of this position (eg, gcode_position.x).
position: The last commanded position of the toolhead using the coordinate system specified in the config file. It is possible to access the x, y, z, and e components of this position (eg, position.x).
homing_origin: The origin of the gcode coordinate system (relative to the coordinate system specified in the config file) to use after a G28 command. The SET_GCODE_OFFSET command can alter this position. It is possible to access the x, y, and z components of this position (eg, homing_origin.x).
speed: The last speed set in a G1 command (in mm/s).
speed_factor: The "speed factor override" as set by an M220 command. This is a floating point value such that 1.0 means no override and, for example, 2.0 would double requested speed.
extrude_factor: The "extrude factor override" as set by an M221 command. This is a floating point value such that 1.0 means no override and, for example, 2.0 would double requested extrusions.
absolute_coordinates: This returns True if in G90 absolute coordinate mode or False if in G91 relative mode.
absolute_extrude: This returns True if in M82 absolute extrude mode or False if in M83 relative mode.

hall_filament_width_sensor

The following information is available in the hall_filament_width_sensor object:

is_active: Returns True if the sensor is currently active.
Diameter: The last reading from the sensor in mm.
Raw: The last raw ADC reading from the sensor.

heater

The following information is available for heater objects such as extruder, heater_bed, and heater_generic:

temperature: The last reported temperature (in Celsius as a float) for the given heater.
target: The current target temperature (in Celsius as a float) for the given heater.
power: The last setting of the PWM pin (a value between 0.0 and 1.0) associated with the heater.
can_extrude: If extruder can extrude (defined by min_extrude_temp), available only for extruder

heaters

The following information is available in the heaters object (this object is available if any heater is defined):

available_heaters: Returns a list of all currently available heaters by their full config section names, e.g. ["extruder", "heater_bed", "heater_generic my_custom_heater"].
available_sensors: Returns a list of all currently available temperature sensors by their full config section names, e.g. ["extruder", "heater_bed", "heater_generic my_custom_heater", "temperature_sensor electronics_temp"].

idle_timeout

The following information is available in the idle_timeout object (this object is always available):

state: The current state of the printer as tracked by the idle_timeout module. It is one of the following strings: "Idle", "Printing", "Ready".
printing_time: The amount of time (in seconds) the printer has been in the "Printing" state (as tracked by the idle_timeout module).

led

The following information is available for each [led led_name], [neopixel led_name], [dotstar led_name], [pca9533 led_name], and [pca9632 led_name] config section defined in printer.cfg:

color_data: A list of color lists containing the RGBW values for a led in the chain. Each value is represented as a float from 0.0 to 1.0. Each color list contains 4 items (red, green, blue, white) even if the underyling LED supports fewer color channels. For example, the blue value (3rd item in color list) of the second neopixel in a chain could be accessed at printer["neopixel <config_name>"].color_data[1][2].

manual_probe

The following information is available in the manual_probe object:

is_active: Returns True if a manual probing helper script is currently active.
z_position: The current height of the nozzle (as the printer currently understands it).
z_position_lower: Last probe attempt just lower than the current height.
z_position_upper: Last probe attempt just greater than the current height.

mcu

The following information is available in mcu and mcu some_name objects:

mcu_version: The Klipper code version reported by the micro-controller.
mcu_build_versions: Information on the build tools used to generate the micro-controller code (as reported by the micro-controller).
mcu_constants.<constant_name>: Compile time constants reported by the micro-controller. The available constants may differ between micro-controller architectures and with each code revision.
last_stats.<statistics_name>: Statistics information on the micro-controller connection.

motion_report

The following information is available in the motion_report object (this object is automatically available if any stepper config section is defined):

live_position: The requested toolhead position interpolated to the current time.
live_velocity: The requested toolhead velocity (in mm/s) at the current time.
live_extruder_velocity: The requested extruder velocity (in mm/s) at the current time.

output_pin

The following information is available in output_pin some_name objects:

value: The "value" of the pin, as set by a SET_PIN command.

palette2

The following information is available in the palette2 object:

ping: Amount of the last reported Palette 2 ping in percent.
remaining_load_length: When starting a Palette 2 print, this will be the amount of filament to load into the extruder.
is_splicing: True when the Palette 2 is splicing filament.

pause_resume

The following information is available in the pause_resume object:

is_paused: Returns true if a PAUSE command has been executed without a corresponding RESUME.

print_stats

The following information is available in the print_stats object (this object is automatically available if a virtual_sdcard config section is defined):

filename, total_duration, print_duration, filament_used, state, message: Estimated information about the current print when a virtual_sdcard print is active.
info.total_layer: The total layer value of the last SET_PRINT_STATS_INFO TOTAL_LAYER=<value> G-Code command.
info.current_layer: The current layer value of the last SET_PRINT_STATS_INFO CURRENT_LAYER=<value> G-Code command.

probe

The following information is available in the probe object (this object is also available if a bltouch config section is defined):

name: Returns the name of the probe in use.
last_query: Returns True if the probe was reported as "triggered" during the last QUERY_PROBE command. Note, if this is used in a macro, due to the order of template expansion, the QUERY_PROBE command must be run prior to the macro containing this reference.
last_z_result: Returns the Z result value of the last PROBE command. Note, if this is used in a macro, due to the order of template expansion, the PROBE (or similar) command must be run prior to the macro containing this reference.

quad_gantry_level

The following information is available in the quad_gantry_level object (this object is available if quad_gantry_level is defined):

applied: True if the gantry leveling process has been run and completed successfully.

query_endstops

The following information is available in the query_endstops object (this object is available if any endstop is defined):

last_query["<endstop>"]: Returns True if the given endstop was reported as "triggered" during the last QUERY_ENDSTOP command. Note, if this is used in a macro, due to the order of template expansion, the QUERY_ENDSTOP command must be run prior to the macro containing this reference.

screws_tilt_adjust

The following information is available in the screws_tilt_adjust object:

error: Returns True if the most recent SCREWS_TILT_CALCULATE command included the MAX_DEVIATION parameter and any of the probed screw points exceeded the specified MAX_DEVIATION.
max_deviation: Return the last MAX_DEVIATION value of the most recent SCREWS_TILT_CALCULATE command.
results["<screw>"]: A dictionary containing the following keys:
- z: The measured Z height of the screw location.
- sign: A string specifying the direction to turn to screw for the necessary adjustment. Either "CW" for clockwise or "CCW" for counterclockwise.
- adjust: The number of screw turns to adjust the screw, given in the format "HH:MM," where "HH" is the number of full screw turns and "MM" is the number of "minutes of a clock face" representing a partial screw turn. (E.g. "01:15" would mean to turn the screw one and a quarter revolutions.)
- is_base: Returns True if this is the base screw.

servo

The following information is available in servo some_name objects:

printer["servo <config_name>"].value: The last setting of the PWM pin (a value between 0.0 and 1.0) associated with the servo.

stepper_enable

The following information is available in the stepper_enable object (this object is available if any stepper is defined):

steppers["<stepper>"]: Returns True if the given stepper is enabled.

system_stats

The following information is available in the system_stats object (this object is always available):

sysload, cputime, memavail: Information on the host operating system and process load.

temperature sensors

The following information is available in

bme280 config_section_name, htu21d config_section_name, lm75 config_section_name, temperature_host config_section_name and temperature_combined config_section_name objects:

temperature: The last read temperature from the sensor.
humidity, pressure, gas: The last read values from the sensor (only on bme280, htu21d, and lm75 sensors).

temperature_fan

The following information is available in temperature_fan some_name objects:

temperature: The last read temperature from the sensor.
target: The target temperature for the fan.

temperature_sensor

The following information is available in temperature_sensor some_name objects:

temperature: The last read temperature from the sensor.
measured_min_temp, measured_max_temp: The lowest and highest temperature seen by the sensor since the Klipper host software was last restarted.

tmc drivers

The following information is available in TMC stepper driver objects (eg, [tmc2208 stepper_x]):

mcu_phase_offset: The micro-controller stepper position corresponding with the driver's "zero" phase. This field may be null if the phase offset is not known.
phase_offset_position: The "commanded position" corresponding to the driver's "zero" phase. This field may be null if the phase offset is not known.
drv_status: The results of the last driver status query. (Only non-zero fields are reported.) This field will be null if the driver is not enabled (and thus is not periodically queried).
temperature: The internal temperature reported by the driver. This field will be null if the driver is not enabled or if the driver does not support temperature reporting.
run_current: The currently set run current.
hold_current: The currently set hold current.

toolhead

The following information is available in the toolhead object (this object is always available):

position: The last commanded position of the toolhead relative to the coordinate system specified in the config file. It is possible to access the x, y, z, and e components of this position (eg, position.x).
extruder: The name of the currently active extruder. For example, in a macro one could use printer[printer.toolhead.extruder].target to get the target temperature of the current extruder.
homed_axes: The current cartesian axes considered to be in a "homed" state. This is a string containing one or more of "x", "y", "z".
axis_minimum, axis_maximum: The axis travel limits (mm) after homing. It is possible to access the x, y, z components of this limit value (eg, axis_minimum.x, axis_maximum.z).
For Delta printers the cone_start_z is the max z height at maximum radius (printer.toolhead.cone_start_z).
max_velocity, max_accel, max_accel_to_decel, square_corner_velocity: The current printing limits that are in effect. This may differ from the config file settings if a SET_VELOCITY_LIMIT (or M204) command alters them at run-time.
stalls: The total number of times (since the last restart) that the printer had to be paused because the toolhead moved faster than moves could be read from the G-Code input.

dual_carriage

The following information is available in dual_carriage on a cartesian, hybrid_corexy or hybrid_corexz robot

carriage_0: The mode of the carriage 0. Possible values are: "INACTIVE" and "PRIMARY".
carriage_1: The mode of the carriage 1. Possible values are: "INACTIVE", "PRIMARY", "COPY", and "MIRROR".

virtual_sdcard

The following information is available in the virtual_sdcard object:

is_active: Returns True if a print from file is currently active.
progress: An estimate of the current print progress (based of file size and file position).
file_path: A full path to the file of currently loaded file.
file_position: The current position (in bytes) of an active print.
file_size: The file size (in bytes) of currently loaded file.

webhooks

The following information is available in the webhooks object (this object is always available):

state: Returns a string indicating the current Klipper state. Possible values are: "ready", "startup", "shutdown", "error".
state_message: A human readable string giving additional context on the current Klipper state.

z_thermal_adjust

The following information is available in the z_thermal_adjust object (this object is available if z_thermal_adjust is defined).

enabled: Returns True if adjustment is enabled.
temperature: Current (smoothed) temperature of the defined sensor. [degC]
measured_min_temp: Minimum measured temperature. [degC]
measured_max_temp: Maximum measured temperature. [degC]
current_z_adjust: Last computed Z adjustment [mm].
z_adjust_ref_temperature: Current reference temperature used for calculation of Z current_z_adjust [degC].

z_tilt

The following information is available in the z_tilt object (this object is available if z_tilt is defined):

applied: True if the z-tilt leveling process has been run and completed successfully.

22 KiB Raw Blame History