aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorDamien <damlobster@gmail.com>2021-07-22 00:40:40 +0200
committerKevinOConnor <kevin@koconnor.net>2021-07-27 13:15:25 -0400
commitcff61605fb7260ab60d1abd4e295b71a533869ac (patch)
treef117dd64e85ec18a62c7c4305781fa03d37ed0a9 /docs/Status_Reference.md
parent7e88f9220c641dd1e7e5b748381bd7ac758bc8d2 (diff)
downloadkutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.gz
kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.xz
kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.zip
docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md68
1 files changed, 35 insertions, 33 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index e0da69e3..a15720fa 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -1,3 +1,5 @@
+# Status reference
+
This document is a reference of printer status information available
in Klipper [macros](Command_Templates.md),
[display fields](Config_Reference.md#display), and via the
@@ -8,14 +10,14 @@ attribute be sure to review the
[Config Changes document](Config_Changes.md) when upgrading the
Klipper software.
-# bed_mesh
+## bed_mesh
The following information is available in the
[bed_mesh](Config_Reference.md#bed_mesh) object:
- `profile_name`, `mesh_min`, `mesh_max`, `probed_matrix`,
`mesh_matrix`: Information on the currently active bed_mesh.
-# configfile
+## configfile
The following information is available in the `configfile` object
(this object is always available):
@@ -27,7 +29,7 @@ The following information is available in the `configfile` object
restart. (Any settings changed at run-time will not be reflected
here.) All values are returned as strings.
-# display_status
+## display_status
The following information is available in the `display_status` object
(this object is automatically available if a
@@ -36,7 +38,7 @@ The following information is available in the `display_status` object
`virtual_sdcard.progress` if no recent `M73` received).
- `message`: The message contained in the last `M117` G-Code command.
-# endstop_phase
+## endstop_phase
The following information is available in the
[endstop_phase](Config_Reference.md#endstop_phase) object:
@@ -50,7 +52,7 @@ The following information is available in the
forward direction minus the total number of steps taken in the
reverse direction since the micro-controller was last restarted.
-# fan
+## fan
The following information is available in
[fan](Config_Reference.md#fan),
@@ -61,7 +63,7 @@ objects:
- `rpm`: The measured fan speed in rotations per minute if the fan has
a tachometer_pin defined.
-# filament_switch_sensor
+## filament_switch_sensor
The following information is available in
[filament_switch_sensor some_name](Config_Reference.md#filament_switch_sensor)
@@ -70,7 +72,7 @@ objects:
- `filament_detected`: Returns True if the sensor is in a triggered
state.
-# filament_motion_sensor
+## filament_motion_sensor
The following information is available in
[filament_motion_sensor some_name](Config_Reference.md#filament_motion_sensor)
@@ -79,7 +81,7 @@ objects:
- `filament_detected`: Returns True if the sensor is in a triggered
state.
-# firmware_retraction
+## firmware_retraction
The following information is available in the
[firmware_retraction](Config_Reference.md#firmware_retraction) object:
@@ -88,14 +90,14 @@ The following information is available in the
module. These settings may differ from the config file if a
`SET_RETRACTION` command alters them.
-# gcode_macro
+## gcode_macro
The following information is available in
[gcode_macro some_name](Config_Reference.md#gcode_macro) objects:
- `<variable>`: The current value of a
[gcode_macro variable](Command_Templates.md#variables).
-# gcode_move
+## gcode_move
The following information is available in the `gcode_move` object
(this object is always available):
@@ -124,7 +126,7 @@ The following information is available in the `gcode_move` object
- `absolute_extrude`: This returns True if in `M82` absolute extrude
mode or False if in `M83` relative mode.
-# hall_filament_width_sensor
+## hall_filament_width_sensor
The following information is available in the
[hall_filament_width_sensor](Config_Reference.md#hall_filament_width_sensor)
@@ -132,7 +134,7 @@ object:
- `is_active`: Returns True if the sensor is currently active.
- `Diameter`, `Raw`: The last read values from the sensor.
-# heater
+## heater
The following information is available for heater objects such as
[extruder](Config_Reference.md#extruder),
@@ -147,7 +149,7 @@ The following information is available for heater objects such as
- `can_extrude`: If extruder can extrude (defined by `min_extrude_temp`),
available only for [extruder](Config_Reference.md#extruder)
-# heaters
+## heaters
The following information is available in the `heaters` object (this
object is available if any heater is defined):
@@ -159,7 +161,7 @@ object is available if any heater is defined):
e.g. `["extruder", "heater_bed", "heater_generic my_custom_heater",
"temperature_sensor electronics_temp"]`.
-# idle_timeout
+## idle_timeout
The following information is available in the
[idle_timeout](Config_Reference.md#idle_timeout) object (this object
@@ -171,7 +173,7 @@ is always available):
been in the "Printing" state (as tracked by the idle_timeout
module).
-# mcu
+## mcu
The following information is available in
[mcu](Config_Reference.md#mcu) and
@@ -187,13 +189,13 @@ The following information is available in
- `last_stats.<statistics_name>`: Statistics information on the
micro-controller connection.
-# output_pin
+## output_pin
The following information is available in
[output_pin some_name](Config_Reference.md#output_pin) objects:
- `value`: The "value" of the pin, as set by a `SET_PIN` command.
-# palette2
+## palette2
The following information is available in the
[palette2](Config_Reference.md#palette2) object:
@@ -202,14 +204,14 @@ The following information is available in the
be the amount of filament to load into the extruder.
- `is_splicing`: True when the Palette 2 is splicing filament.
-# pause_resume
+## pause_resume
The following information is available in the
[pause_resume](Config_Reference.md#pause_resume) object:
- `is_paused`: Returns true if a PAUSE command has been executed
without a corresponding RESUME.
-# print_stats
+## print_stats
The following information is available in the `print_stats` object
(this object is automatically available if a
@@ -219,7 +221,7 @@ defined):
`state`, `message`: Estimated information about the current print
when a virtual_sdcard print is active.
-# probe
+## probe
The following information is available in the
[probe](Config_Reference.md#probe) object (this object is also
@@ -234,14 +236,14 @@ is defined):
template expansion, the PROBE (or similar) command must be run prior
to the macro containing this reference.
-# quad_gantry_level
+## 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
+## query_endstops
The following information is available in the `query_endstops` object
(this object is available if any endstop is defined):
@@ -251,21 +253,21 @@ The following information is available in the `query_endstops` object
the QUERY_ENDSTOP command must be run prior to the macro containing
this reference.
-# servo
+## servo
The following information is available in
[servo some_name](Config_Reference.md#servo) 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.
-# system_stats
+## 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
+## temperature sensors
The following information is available in
@@ -279,7 +281,7 @@ objects:
- `humidity`, `pressure`, `gas`: The last read values from the sensor
(only on bme280, htu21d, and lm75 sensors).
-# temperature_fan
+## temperature_fan
The following information is available in
[temperature_fan some_name](Config_Reference.md#temperature_fan)
@@ -287,7 +289,7 @@ objects:
- `temperature`: The last read temperature from the sensor.
- `target`: The target temperature for the fan.
-# temperature_sensor
+## temperature_sensor
The following information is available in
[temperature_sensor some_name](Config_Reference.md#temperature_sensor)
@@ -297,7 +299,7 @@ objects:
temperature seen by the sensor since the Klipper host software was
last restarted.
-# toolhead
+## toolhead
The following information is available in the `toolhead` object
(this object is always available):
@@ -322,7 +324,7 @@ The following information is available in the `toolhead` object
the printer had to be paused because the toolhead moved faster than
moves could be read from the G-Code input.
-# dual_carriage
+## dual_carriage
The following information is available in
[dual_carriage](Config_Reference.md#dual_carriage)
@@ -331,7 +333,7 @@ on a hybrid_corexy or hybrid_corexz robot
- `active_carriage`: The current active carriage.
Possible values are: "CARRIAGE_0", "CARRIAGE_1"
-# virtual_sdcard
+## virtual_sdcard
The following information is available in the
[virtual_sdcard](Config_Reference.md#virtual_sdcard) object:
@@ -342,7 +344,7 @@ The following information is available in the
- `file_position`: The current position (in bytes) of an active print.
- `file_size`: The file size (in bytes) of currently loaded file.
-# webhooks
+## webhooks
The following information is available in the `webhooks` object (this
object is always available):
@@ -351,14 +353,14 @@ object is always available):
- `state_message`: A human readable string giving additional context
on the current Klipper state.
-# z_tilt
+## 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.
-# neopixel / dotstar
+## neopixel / dotstar
The following information is available for each `[neopixel led_name]` and
`[dotstar led_name]` defined in printer.cfg:
- `color_data`: An array of objects, with each object containing the RGBW