3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update Status_Reference.md for better Jekyll rendering 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-04-28 20:38:07 -04:00
parent f2e4653ca4
commit ebbb21be00
1 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/Status_Reference.md
View File

@ -38,17 +38,19 @@ The following information is available in the `display_status` object
# fan # fan
The following information is available in The following information is available in
[fan](Config_Reference.md#fan), [heater_fan [fan](Config_Reference.md#fan),
some_name](Config_Reference.md#heater_fan) and [controller_fan [heater_fan some_name](Config_Reference.md#heater_fan) and
some_name](Config_Reference.md#controller_fan) objects: [controller_fan some_name](Config_Reference.md#controller_fan)
objects:
- `speed`: The fan speed as a float between 0.0 and 1.0. - `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 - `rpm`: The measured fan speed in rotations per minute if the fan has
a tachometer_pin defined. a tachometer_pin defined.
# filament_switch_sensor # filament_switch_sensor
The following information is available in [filament_switch_sensor The following information is available in
some_name](Config_Reference.md#filament_switch_sensor) objects: [filament_switch_sensor some_name](Config_Reference.md#filament_switch_sensor)
objects:
- `enabled`: Returns True if the switch sensor is currently enabled. - `enabled`: Returns True if the switch sensor is currently enabled.
- `filament_detected`: Returns True if the sensor is in a triggered - `filament_detected`: Returns True if the sensor is in a triggered
state. state.
@ -64,10 +66,10 @@ The following information is available in the
# gcode_macro # gcode_macro
The following information is available in [gcode_macro The following information is available in
some_name](Config_Reference.md#gcode_macro) objects: [gcode_macro some_name](Config_Reference.md#gcode_macro) objects:
- `<variable>`: The current value of a [gcode_macro - `<variable>`: The current value of a
variable](Command_Templates.md#variables). [gcode_macro variable](Command_Templates.md#variables).
# gcode_move # gcode_move
@ -146,8 +148,8 @@ is always available):
# mcu # mcu
The following information is available in The following information is available in
[mcu](Config_Reference.md#mcu) and [mcu [mcu](Config_Reference.md#mcu) and
some_name](Config_Reference.md#mcu-my_extra_mcu) objects: [mcu some_name](Config_Reference.md#mcu-my_extra_mcu) objects:
- `mcu_version`: The Klipper code version reported by the - `mcu_version`: The Klipper code version reported by the
micro-controller. micro-controller.
- `mcu_build_versions`: Information on the build tools used to - `mcu_build_versions`: Information on the build tools used to
@ -161,8 +163,8 @@ some_name](Config_Reference.md#mcu-my_extra_mcu) objects:
# output_pin # output_pin
The following information is available in [output_pin The following information is available in
some_name](Config_Reference.md#output_pin) objects: [output_pin some_name](Config_Reference.md#output_pin) objects:
- `value`: The "value" of the pin, as set by a `SET_PIN` command. - `value`: The "value" of the pin, as set by a `SET_PIN` command.
# palette2 # palette2
@ -218,8 +220,8 @@ The following information is available in the `query_endstops` object
# servo # servo
The following information is available in [servo The following information is available in
some_name](Config_Reference.md#servo) objects: [servo some_name](Config_Reference.md#servo) objects:
- `printer["servo <config_name>"].value`: The last setting of the PWM - `printer["servo <config_name>"].value`: The last setting of the PWM
pin (a value between 0.0 and 1.0) associated with the servo. pin (a value between 0.0 and 1.0) associated with the servo.
@ -245,15 +247,17 @@ objects:
# temperature_fan # temperature_fan
The following information is available in [temperature_fan The following information is available in
some_name](Config_Reference.md#temperature_fan) objects: [temperature_fan some_name](Config_Reference.md#temperature_fan)
objects:
- `temperature`: The last read temperature from the sensor. - `temperature`: The last read temperature from the sensor.
- `target`: The target temperature for the fan. - `target`: The target temperature for the fan.
# temperature_sensor # temperature_sensor
The following information is available in [temperature_sensor The following information is available in
some_name](Config_Reference.md#temperature_sensor) objects: [temperature_sensor some_name](Config_Reference.md#temperature_sensor)
objects:
- `temperature`: The last read temperature from the sensor. - `temperature`: The last read temperature from the sensor.
- `measured_min_temp`, `measured_max_temp`: The lowest and highest - `measured_min_temp`, `measured_max_temp`: The lowest and highest
temperature seen by the sensor since the Klipper host software was temperature seen by the sensor since the Klipper host software was