aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2020-10-12 11:00:54 -0400
committerKevin O'Connor <kevin@koconnor.net>2020-10-16 21:52:02 -0400
commit3a15219de3bb5602d0fd39927f06dd612ea896f1 (patch)
tree10e7733e7b0925097dea53a830c799daa8011560
parenta87e5616a033464d761552e0ff77fd7b46f40800 (diff)
downloadkutter-3a15219de3bb5602d0fd39927f06dd612ea896f1.tar.gz
kutter-3a15219de3bb5602d0fd39927f06dd612ea896f1.tar.xz
kutter-3a15219de3bb5602d0fd39927f06dd612ea896f1.zip
config: Formatting changes to example-extras.cfg
Updates to improve consistency of example-extras.cfg formatting. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
-rw-r--r--config/example-extras.cfg601
1 files changed, 314 insertions, 287 deletions
diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 2f2bc4cf..73e5cc19 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -12,13 +12,12 @@
# Bed leveling support
######################################################################
-# Mesh Bed Leveling. One may define a [bed_mesh] config section
-# to enable move transformations that offset the z axis based
-# on a mesh generated from probed points. Note that bed_mesh
-# and bed_tilt are incompatible, both cannot be defined. When
-# using a probe to home the z-axis, it is recommended to define
-# a [homing_override] section in printer.cfg to home toward the
-# center of the print area.
+# Mesh Bed Leveling. One may define a [bed_mesh] config section to
+# enable move transformations that offset the z axis based on a mesh
+# generated from probed points. Note that bed_mesh and bed_tilt are
+# incompatible, both cannot be defined. When using a probe to home the
+# z-axis, it is recommended to define a [homing_override] section in
+# printer.cfg to home toward the center of the print area.
#
# Visual Examples:
# rectangular bed, probe_count = 3,3:
@@ -47,52 +46,52 @@
# The height (in mm) that the head should be commanded to move to
# just prior to starting a probe operation. The default is 5.
#mesh_radius:
-# Defines the radius of the mesh to probe for round beds. Note that the
-# radius is relative to the coordinate specified by the mesh_origin option.
-# This parameter must be provided for round beds and omitted for rectangular
-# beds.
+# Defines the radius of the mesh to probe for round beds. Note that
+# the radius is relative to the coordinate specified by the
+# mesh_origin option. This parameter must be provided for round beds
+# and omitted for rectangular beds.
#mesh_origin:
-# Defines the center x,y coordinate of the mesh for round beds. This
-# coordinate is relative to the probe's location. It may be useful
+# Defines the center x,y coordinate of the mesh for round beds. This
+# coordinate is relative to the probe's location. It may be useful
# to adjust the mesh_origin in an effort to maximize the size of the
-# mesh radius. Default is 0,0. This parameter must be omitted for
+# mesh radius. Default is 0,0. This parameter must be omitted for
# rectangular beds.
#mesh_min:
-# Defines the minimum x,y coodinate of the mesh for rectangular beds. This
-# coordinate is relative to the probe's location. This will be the first
-# point probed, nearest to the origin. This parameter must be provided for
-# rectangular beds.
+# Defines the minimum x,y coodinate of the mesh for rectangular
+# beds. This coordinate is relative to the probe's location. This
+# will be the first point probed, nearest to the origin. This
+# parameter must be provided for rectangular beds.
#mesh_max:
-# Defines the maximum x,y coordinate of the mesh for rectangular beds.
-# Adheres to the same principle as mesh_min, however this will be the
-# furthest point probed from the bed's origin. This parameter must be
-# provided for rectangular beds.
+# Defines the maximum x,y coordinate of the mesh for rectangular
+# beds. Adheres to the same principle as mesh_min, however this will
+# be the furthest point probed from the bed's origin. This parameter
+# must be provided for rectangular beds.
#probe_count: 3,3
# For rectangular beds, this is a comma separate pair of integer
-# values (X,Y) defining the number of points to probe along each axis.
-# A single value is also valid, in which case that value will be applied
-# to both axes. Default is 3,3.
+# values (X,Y) defining the number of points to probe along each
+# axis. A single value is also valid, in which case that value will
+# be applied to both axes. Default is 3,3.
#round_probe_count: 5
# For round beds, this integer value defines the maximum number of
# points to probe along each axis. This value must be an odd number.
# Default is 5.
#fade_start: 1.0
# The gcode z position in which to start phasing out z-adjustment
-# when fade is enabled. Default is 1.0.
+# when fade is enabled. Default is 1.0.
#fade_end: 0.0
-# The gcode z position in which phasing out completes. When set
-# to a value below fade_start, fade is disabled. It should be
-# noted that fade may add unwanted scaling along the z-axis of a
-# print. If a user wishes to enable fade, a value of 10.0 is
-# recommended. Default is 0.0, which disables fade.
+# The gcode z position in which phasing out completes. When set to a
+# value below fade_start, fade is disabled. It should be noted that
+# fade may add unwanted scaling along the z-axis of a print. If a
+# user wishes to enable fade, a value of 10.0 is recommended.
+# Default is 0.0, which disables fade.
#fade_target:
-# The z position in which fade should converge. When this value is set
-# to a non-zero value it must be within the range of z-values in the mesh.
-# Users that wish to converge to the z homing position should set this to 0.
-# Default is the average z value of the mesh.
+# The z position in which fade should converge. When this value is
+# set to a non-zero value it must be within the range of z-values in
+# the mesh. Users that wish to converge to the z homing position
+# should set this to 0. Default is the average z value of the mesh.
#split_delta_z: .025
-# The amount of Z difference (in mm) along a move that will
-# trigger a split. Default is .025.
+# The amount of Z difference (in mm) along a move that will trigger
+# a split. Default is .025.
#move_check_distance: 5.0
# The distance (in mm) along a move to check for split_delta_z.
# This is also the minimum length that a move can be split. Default
@@ -100,18 +99,18 @@
#mesh_pps: 2,2
# A comma separated pair of integers (X,Y) defining the number of
# points per segment to interpolate in the mesh along each axis. A
-# "segment" can be defined as the space between each probed
-# point. The user may enter a single value which will be applied
-# to both axes. Default is 2,2.
+# "segment" can be defined as the space between each probed point.
+# The user may enter a single value which will be applied to both
+# axes. Default is 2,2.
#algorithm: lagrange
-# The interpolation algorithm to use. May be either "lagrange"
-# or "bicubic". This option will not affect 3x3 grids, which
-# are forced to use lagrange sampling. Default is lagrange.
+# The interpolation algorithm to use. May be either "lagrange" or
+# "bicubic". This option will not affect 3x3 grids, which are forced
+# to use lagrange sampling. Default is lagrange.
#bicubic_tension: .2
-# When using the bicubic algorithm the tension parameter above
-# may be applied to change the amount of slope interpolated.
-# Larger numbers will increase the amount of slope, which
-# results in more curvature in the mesh. Default is .2.
+# When using the bicubic algorithm the tension parameter above may
+# be applied to change the amount of slope interpolated. Larger
+# numbers will increase the amount of slope, which results in more
+# curvature in the mesh. Default is .2.
#relative_reference_index:
# A point index in the mesh to reference all z values to. Enabling
# this parameter produces a mesh relative to the probed z position
@@ -267,36 +266,35 @@
# Where x is the (0,0) point on the bed
#[quad_gantry_level]
#gantry_corners:
-# A newline separated list of X,Y coordinates describing the
-# two opposing corners of the gantry. The first entry corresponds to
-# Z, the second to Z2.
-# This parameter must be provided.
+# A newline separated list of X,Y coordinates describing the two
+# opposing corners of the gantry. The first entry corresponds to Z,
+# the second to Z2. This parameter must be provided.
#points:
# A newline separated list of four X,Y points that should be probed
-# during a QUAD_GANTRY_LEVEL command.
-# Order of the locations is important, and should correspond to Z,Z1
-# Z2, and Z3 location in order.
-# This parameter must be provided.
-# For maximum accuracy, ensure your probe offsets are configured.
+# during a QUAD_GANTRY_LEVEL command. Order of the locations is
+# important, and should correspond to Z, Z1, Z2, and Z3 location in
+# order. This parameter must be provided. For maximum accuracy,
+# ensure your probe offsets are configured.
#speed: 50
# The speed (in mm/s) of non-probing moves during the calibration.
# The default is 50.
#horizontal_move_z: 5
# The height (in mm) that the head should be commanded to move to
-# just prior to starting a probe operation. The default is 5
+# just prior to starting a probe operation. The default is 5.
#max_adjust: 4
# Safety limit if an ajustment greater than this value is requested
# quad_gantry_level will abort.
#retries: 0
-# number of times to retry if the probed points aren't within tolerance
+# Number of times to retry if the probed points aren't within
+# tolerance.
#retry_tolerance: 0
-# if retries are enabled then retry if largest and smallest probed points
-# differ more than retry_tolerance
+# If retries are enabled then retry if largest and smallest probed
+# points differ more than retry_tolerance.
-# Printer Skew Correction. It is possible to use software to correct
-# printer skew across 3 planes, xy, xz, yz. This is done by printing
-# a calibration model along a plane and measuring three lengths. Due
-# to the nature of skew correction these lengths are set via gcode. See
+# Printer Skew Correction. It is possible to use software to correct
+# printer skew across 3 planes, xy, xz, yz. This is done by printing a
+# calibration model along a plane and measuring three lengths. Due to
+# the nature of skew correction these lengths are set via gcode. See
# skew_correction.md and G-Codes.md in the docs directory for details.
#[skew_correction]
@@ -326,10 +324,11 @@
# home requests so that the Z boundary checks are accurate. The
# default is to not implement Z hop.
#z_hop_speed: 20.0
-# Speed at which the Z axis is lifted prior to homing. The default is 20mm/s.
+# Speed at which the Z axis is lifted prior to homing. The default
+# is 20mm/s.
#move_to_previous: False
-# When set to True, xy are reset to their previous positions after z homing.
-# The default is False.
+# When set to True, xy are reset to their previous positions after z
+# homing. The default is False.
# Homing override. One may use this mechanism to run a series of
@@ -433,14 +432,15 @@
# Execute a gcode on a set delay.
#[delayed_gcode my_delayed_gcode]
#initial_duration: 0.
-# The duration of the initial delay (in seconds). If set to a non-zero
-# value the delayed_gcode will execute the specified number of seconds
-# after the printer enters the "ready" state. This can be useful for
-# initialization procedures or a repeating delayed_gcode. If set to 0
-# the delayed_gcode will not execute on startup. Default is 0.
+# The duration of the initial delay (in seconds). If set to a
+# non-zero value the delayed_gcode will execute the specified number
+# of seconds after the printer enters the "ready" state. This can be
+# useful for initialization procedures or a repeating delayed_gcode.
+# If set to 0 the delayed_gcode will not execute on startup.
+# Default is 0.
#gcode:
# A list of G-Code commands to execute when the delay duration has
-# elapsed. G-Code templates are supported. This parameter must be
+# elapsed. G-Code templates are supported. This parameter must be
# provided.
# Idle timeout. An idle timeout is automatically enabled - add an
@@ -483,7 +483,7 @@
#[pause_resume]
#recover_velocity: 50.
# When capture/restore is enabled, the speed at which to return to
-# the captured position (in mm/s). Default is 50.0 mm/s.
+# the captured position (in mm/s). Default is 50.0 mm/s.
# Firmware filament retraction. This enables G10 (retract) and G11
# (unretract) GCODE commands issued by many slicers. The parameters
@@ -492,35 +492,38 @@
# runtime tuning.
#[firmware_retraction]
#retract_length: 0
-# The length of filament (in mm) to retract when G10 is activated, and to
-# unretract when G11 is activated (but see unretract_extra_length below).
-# The default is 0 mm.
+# The length of filament (in mm) to retract when G10 is activated,
+# and to unretract when G11 is activated (but see
+# unretract_extra_length below). The default is 0 mm.
#retract_speed: 20
# The speed of retraction, in mm/s. The default is 20 mm/s.
#unretract_extra_length: 0
-# The length (in mm) of *additional* filament to add when unretracting.
+# The length (in mm) of *additional* filament to add when
+# unretracting.
#unretract_speed: 10
# The speed of unretraction, in mm/s. The default is 10 mm/s.
# Support for gcode arc (G2/G3) commands.
#[gcode_arcs]
#resolution: 1.0
-# An arc will be split into segments. Each segment's length will equal
-# the resolution in mm set above. Lower values will produce a finer arc,
-# but also more work for your machine. Arcs smaller than the configured
-# value will become straight lines. The default is 1mm.
+# An arc will be split into segments. Each segment's length will
+# equal the resolution in mm set above. Lower values will produce a
+# finer arc, but also more work for your machine. Arcs smaller than
+# the configured value will become straight lines. The default is
+# 1mm.
# Enable the "M118" and "RESPOND" extended commands.
-# [respond]
-# default_type: echo
-# Sets the default prefix of the "M118" and "RESPOND" output to one of
-# the following:
-# echo: "echo: " (This is the default)
-# command: "// "
-# error: "!! "
-# default_prefix: echo:
-# Directly sets the default prefix. If present, this value will override
-# the "default_type".
+#[respond]
+#default_type: echo
+# Sets the default prefix of the "M118" and "RESPOND" output to one of
+# the following:
+# echo: "echo: " (This is the default)
+# command: "// "
+# error: "!! "
+#default_prefix: echo:
+# Directly sets the default prefix. If present, this value will
+# override the "default_type".
+
######################################################################
# Resonance compensation
@@ -529,32 +532,34 @@
# Enables input shaping.
#[input_shaper]
#shaper_freq_x: 0
-# A frequency (in Hz) of the input shaper for X axis. This is usually a
-# resonance frequency of X axis that the input shaper should suppress.
-# For more complex shapers, like 2- and 3-hump EI input shapers, this
-# parameter can be set from different considerations.
-# The default value is 0, which disables input shaping for X axis.
+# A frequency (in Hz) of the input shaper for X axis. This is
+# usually a resonance frequency of X axis that the input shaper
+# should suppress. For more complex shapers, like 2- and 3-hump EI
+# input shapers, this parameter can be set from different
+# considerations. The default value is 0, which disables input
+# shaping for X axis.
#shaper_freq_y: 0
-# A frequency (in Hz) of the input shaper for Y axis. This is usually a
-# resonance frequency of Y axis that the input shaper should suppress.
-# For more complex shapers, like 2- and 3-hump EI input shapers, this
-# parameter can be set from different considerations.
-# The default value is 0, which disables input shaping for Y axis.
+# A frequency (in Hz) of the input shaper for Y axis. This is
+# usually a resonance frequency of Y axis that the input shaper
+# should suppress. For more complex shapers, like 2- and 3-hump EI
+# input shapers, this parameter can be set from different
+# considerations. The default value is 0, which disables input
+# shaping for Y axis.
#shaper_type: mzv
-# A type of the input shaper to use for both X and Y axes. Supported shapers
-# are zv, mzv, zvd, ei, 2hump_ei, and 3hump_ei.
-# The default is mzv input shaper.
+# A type of the input shaper to use for both X and Y axes. Supported
+# shapers are zv, mzv, zvd, ei, 2hump_ei, and 3hump_ei. The default
+# is mzv input shaper.
#shaper_type_x:
#shaper_type_y:
-# If shaper_type is not set, these two parameters can be used to configure
-# different input shapers for X and Y axes. The same values are supported
-# as for shaper_type parameter.
+# If shaper_type is not set, these two parameters can be used to
+# configure different input shapers for X and Y axes. The same
+# values are supported as for shaper_type parameter.
#damping_ratio_x: 0.1
#damping_ratio_y: 0.1
-# Damping ratios of vibrations of X and Y axes used by input shapers to
-# improve vibration suppression. Should not be changed without some proper
-# measurements, e.g. with an accelerometer.
-# Default value is 0.1 which is a good all-round value for most printers.
+# Damping ratios of vibrations of X and Y axes used by input shapers
+# to improve vibration suppression. Should not be changed without
+# some proper measurements, e.g. with an accelerometer. Default
+# value is 0.1 which is a good all-round value for most printers.
# Support for ADXL345 accelerometers. This support allows one to query
# accelerometer measurements from the sensor. This enables an
@@ -570,10 +575,11 @@
# It is also possible to negate an axis if the accelerometer
# direction is reversed (eg, "x,z,-y"). The default is "x,y,z".
#rate: 3200
-# Output data rate for ADXL345. ADXL345 supports the following data rates:
-# 3200, 1600, 800, 400, 200, 100, 50, and 25. Note that it is not recommended
-# to change this rate from the default 3200, and rates below 800 will
-# considerably affect the quality of resonance measurements.
+# Output data rate for ADXL345. ADXL345 supports the following data
+# rates: 3200, 1600, 800, 400, 200, 100, 50, and 25. Note that it is
+# not recommended to change this rate from the default 3200, and
+# rates below 800 will considerably affect the quality of resonance
+# measurements.
#cs_pin:
# The SPI enable pin for the sensor. This parameter must be
# provided.
@@ -587,45 +593,50 @@
# These optional parameters allow one to customize the SPI settings
# used to communicate with the chip.
-# Support for resonance testing and automatic input shaper calibration.
-# In order to use most of the functionality of this module, additional
-# software dependencies must be installed; refer to docs/Measuring_Resonances.md
-# for more information.
+# Support for resonance testing and automatic input shaper
+# calibration. In order to use most of the functionality of this
+# module, additional software dependencies must be installed; refer to
+# docs/Measuring_Resonances.md for more information.
#[resonance_tester]
#probe_points:
# A list of X,Y,Z coordinates of points (one point per line) to test
# resonances at. At least one point is required. Make sure that all
-# points with some safety margin in XY plane (~a few centimeters) are
-# reachable by the toolhead.
+# points with some safety margin in XY plane (~a few centimeters)
+# are reachable by the toolhead.
#accel_chip:
-# A name of the accelerometer chip to use for measurements. If adxl345 chip
-# was defined without an explicit name, this parameter can simply reference
-# it as "accel_chip: adxl345", otherwise an explicit name must be supplied
-# as well, e.g. "accel_chip: adxl345 my_chip_name". Either this, or the next
-# two parameters must be set.
+# A name of the accelerometer chip to use for measurements. If
+# adxl345 chip was defined without an explicit name, this parameter
+# can simply reference it as "accel_chip: adxl345", otherwise an
+# explicit name must be supplied as well, e.g. "accel_chip: adxl345
+# my_chip_name". Either this, or the next two parameters must be
+# set.
#accel_chip_x:
#accel_chip_y:
-# Names of the accelerometer chips to use for measurements for each of the
-# axis. Can be useful, for instance, on bed slinger printer, if two separate
-# accelerometers are mounted on the bed (for Y axis) and on the toolhead (for
-# X axis). These parameters have the same format as 'accel_chip' parameter.
-# Only 'accel_chip' or these two parameters must be provided.
+# Names of the accelerometer chips to use for measurements for each
+# of the axis. Can be useful, for instance, on bed slinger printer,
+# if two separate accelerometers are mounted on the bed (for Y axis)
+# and on the toolhead (for X axis). These parameters have the same
+# format as 'accel_chip' parameter. Only 'accel_chip' or these two
+# parameters must be provided.
#min_freq: 5
# Minimum frequency to test for resonances. The default is 5 Hz.
#max_freq: 120
# Maximum frequency to test for resonances. The default is 120 Hz.
#accel_per_hz: 75
-# This parameter is used to determine which acceleration to use to test a
-# specific frequency: accel = accel_per_hz * freq. Higher the value, the
-# higher is the energy of the oscillations. Can be set to a lower than the
-# default value if the resonances get too strong on the printer. However,
-# lower values make measurements of high-frequency resonances less precise.
-# The default value is 75 (mm/sec).
+# This parameter is used to determine which acceleration to use to
+# test a specific frequency: accel = accel_per_hz * freq. Higher the
+# value, the higher is the energy of the oscillations. Can be set to
+# a lower than the default value if the resonances get too strong on
+# the printer. However, lower values make measurements of
+# high-frequency resonances less precise. The default value is 75
+# (mm/sec).
#hz_per_sec: 1
-# Determines the speed of the test. When testing all frequencies in range
-# [min_freq, max_freq], each second the frequency increases by hz_per_sec.
-# Small values make the test slow, and the large values will decrease the
-# precision of the test. The default value is 1.0 (Hz/sec == sec^-2).
+# Determines the speed of the test. When testing all frequencies in
+# range [min_freq, max_freq], each second the frequency increases by
+# hz_per_sec. Small values make the test slow, and the large values
+# will decrease the precision of the test. The default value is 1.0
+# (Hz/sec == sec^-2).
+
######################################################################
# Config file helpers
@@ -811,7 +822,7 @@
#...
#shared_heater:
# If this extruder uses the same heater already defined for another
-# extruder then place the name of that extruder here. For example,
+# extruder then place the name of that extruder here. For example,
# should extruder3 and extruder4 share a heater then the extruder3
# config section should define the heater and the extruder4 section
# should specify "shared_heater: extruder3". The default is to not
@@ -1051,50 +1062,55 @@
# pullup_resistor parameter (see example.cfg for details). At least
# two measurements must be provided.
-# BME280 two wire interface (I2C) environmental sensor. Note that this
-# sensor is not intended for use with extruders and heater beds, but rather
-# for montitoring ambient temperature (C), pressure (hPa), and relative
-# humidity. See sample-macros.cfg for a gcode_macro that may be used to report
-# pressure and humidity in addition to temperature.
+# BME280 two wire interface (I2C) environmental sensor. Note that this
+# sensor is not intended for use with extruders and heater beds, but
+# rather for montitoring ambient temperature (C), pressure (hPa), and
+# relative humidity. See sample-macros.cfg for a gcode_macro that may
+# be used to report pressure and humidity in addition to temperature.
#[temperature_sensor my_sensor]
# See the "temperature_sensor" section below for a description of its
# parameters. The parameters below describe BME280 sensor parameters.
#sensor_type:
# Must be "BME280"
#i2c_address:
-# Default is 118 (0x76). Some BME280 sensors have an address of 119 (0x77).
+# Default is 118 (0x76). Some BME280 sensors have an address of 119
+# (0x77).
#i2c_mcu:
-# MCU the sensor is connected to. Default is the primary mcu.
+# MCU the sensor is connected to. Default is the primary mcu.
#i2c_bus:
-# The I2C bus the sensor is connected to. On some MCU platforms the default
-# is bus 0. On platforms without bus 0 this parameter is required.
+# The I2C bus the sensor is connected to. On some MCU platforms the
+# default is bus 0. On platforms without bus 0 this parameter is
+# required.
#i2c_speed:
-# The I2C speed (in Hz) to use when communicating with the sensor. Default
-# is 100000. On some MCUs changing this value has no effect.
+# The I2C speed (in Hz) to use when communicating with the sensor.
+# Default is 100000. On some MCUs changing this value has no effect.
-# HTU21D family two wire interface (I2C) environmental sensor.
-# Note that this sensor is not intended for use with extruders and heater beds,
-# but rather for montitoring ambient temperature (C) and relative humidity.
-# See sample-macros.cfg for a gcode_macro that may be used to report humidity
-# in addition to temperature.
+# HTU21D family two wire interface (I2C) environmental sensor. Note
+# that this sensor is not intended for use with extruders and heater
+# beds, but rather for montitoring ambient temperature (C) and
+# relative humidity. See sample-macros.cfg for a gcode_macro that may
+# be used to report humidity in addition to temperature.
#[temperature_sensor my_sensor]
# See the "temperature_sensor" section below for a description of its
-# parameters. The parameters below describe HTU21D family sensor parameters.
+# parameters. The parameters below describe HTU21D family sensor
+# parameters.
#sensor_type:
# Must be "HTU21D" , "SI7013", "SI7020", "SI7021" or "SHT21"
#i2c_address:
-# Default is 64 (0x40).
+# Default is 64 (0x40).
#i2c_mcu:
-# MCU the sensor is connected to. Default is the primary mcu.
+# MCU the sensor is connected to. Default is the primary mcu.
#i2c_bus:
-# The I2C bus the sensor is connected to. On some MCU platforms the default
-# is bus 0. On platforms without bus 0 this parameter is required.
+# The I2C bus the sensor is connected to. On some MCU platforms the
+# default is bus 0. On platforms without bus 0 this parameter is
+# required.
#i2c_speed:
-# The I2C speed (in Hz) to use when communicating with the sensor. Default
-# is 100000. On some MCUs changing this value has no effect.
+# The I2C speed (in Hz) to use when communicating with the sensor.
+# Default is 100000. On some MCUs changing this value has no effect.
#htu21d_hold_master:
-# If the sensor can hold the I2C buf while reading. If True no other bus
-# comunication can be performed while reading is in progress.Default is False
+# If the sensor can hold the I2C buf while reading. If True no other
+# bus comunication can be performed while reading is in progress.
+# Default is False.
#htu21d_resolution:
# The resolution of temperature and humidity reading.
# Valid values are:
@@ -1104,31 +1120,34 @@
# 'TEMP11_HUM11' -> 11bit for Temp and 11bit for humidity
# Default is: "TEMP11_HUM11"
#htu21d_report_time:
-# interval in seconds between readings. Default is 30
+# Interval in seconds between readings. Default is 30
-# LM75/LM75A two wire (I2C) connected temperature sensors.
-# These sensors have range up to 125 C, so are usable for e.g. chamber
-# temperature monitoring. They can also function as simple
-# fan/heater controllers but this mode is not used here.
+# LM75/LM75A two wire (I2C) connected temperature sensors. These
+# sensors have range up to 125 C, so are usable for e.g. chamber
+# temperature monitoring. They can also function as simple fan/heater
+# controllers but this mode is not used here.
#[temperature_sensor my_sensor]
# See the "temperature_sensor" section below for a description of its
-# parameters. The parameters below describe LM75 family sensor parameters.
+# parameters. The parameters below describe LM75 family sensor
+# parameters.
#sensor_type:
-# Must be "LM75"
+# Must be "LM75".
#i2c_address:
-# Default is 72 (0x48). Normal range is 72-79 (0x48-0x4F) and the 3 low
-# bits of the address are configured via pins on the chip (usually
-# with jumpers or hard wired).
+# Default is 72 (0x48). Normal range is 72-79 (0x48-0x4F) and the 3
+# low bits of the address are configured via pins on the chip
+# (usually with jumpers or hard wired).
#i2c_mcu:
-# MCU the sensor is connected to. Default is the primary mcu.
+# MCU the sensor is connected to. Default is the primary mcu.
#i2c_bus:
-# The I2C bus the sensor is connected to. On some MCU platforms the default
-# is bus 0. On platforms without bus 0 this parameter is required.
+# The I2C bus the sensor is connected to. On some MCU platforms the
+# default is bus 0. On platforms without bus 0 this parameter is
+# required.
#i2c_speed:
-# The I2C speed (in Hz) to use when communicating with the sensor. Default
-# is 100000. On some MCUs changing this value has no effect.
+# The I2C speed (in Hz) to use when communicating with the sensor.
+# Default is 100000. On some MCUs changing this value has no effect.
#lm75_report_time:
-# interval in seconds between readings. Default is 0.8, with minimum 0.5
+# Interval in seconds between readings. Default is 0.8, with minimum
+# 0.5.
# Generic heaters (one may define any number of sections with a
# "heater_generic" prefix). These heaters behave similarly to standard
@@ -1184,6 +1203,7 @@
#cycle_time:
#hardware_pwm:
#kick_start_time:
+#off_below:
# See the "fan" section in example.cfg for a description of the
# above parameters.
#heater: extruder
@@ -1212,6 +1232,7 @@
#cycle_time:
#hardware_pwm:
#kick_start_time:
+#off_below:
# See the "fan" section in example.cfg for a description of the
# above parameters.
#fan_speed: 1.0
@@ -1224,8 +1245,8 @@
# is 30 seconds.
#idle_speed:
# The fan speed (expressed as a value from 0.0 to 1.0) that the fan
-# will be set to when a heater or stepper driver was active and before
-# the idle_timeout is reached. The default is fan_speed.
+# will be set to when a heater or stepper driver was active and
+# before the idle_timeout is reached. The default is fan_speed.
#heater:
# Name of the config section defining the heater that this fan is
# associated with. If a comma separated list of heater names is
@@ -1244,6 +1265,7 @@
#cycle_time:
#hardware_pwm:
#kick_start_time:
+#off_below:
# See the "fan" section in example.cfg for a description of the
# above parameters.
#sensor_type: EPCOS 100K B57560G104F
@@ -1293,12 +1315,20 @@
# If set, the temperature will be reported in M105 queries using the
# given id. The default is to not report the temperature via M105.
-
-# Manually controlled fan (one may define any number of sections with a
-# "fan_generic" prefix). The speed of a manually controlled fan is set with the
-# SET_FAN_SPEED gcode command.
+# Manually controlled fan (one may define any number of sections with
+# a "fan_generic" prefix). The speed of a manually controlled fan is
+# set with the SET_FAN_SPEED gcode command.
#[fan_generic extruder_partfan]
-# Options are the same as for the [fan] section
+#pin:
+#max_power:
+#shutdown_speed:
+#cycle_time:
+#hardware_pwm:
+#kick_start_time:
+#off_below:
+# See the "fan" section in example.cfg for a description of the
+# above parameters.
+
######################################################################
# Additional servos, LEDs, buttons, and other pins
@@ -1636,7 +1666,8 @@
#cs_pin:
# The pin corresponding to the TMC2660 chip select line. This pin
# will be set to low at the start of SPI messages and set to high
-# after the message transfer completes. This parameter must be provided.
+# after the message transfer completes. This parameter must be
+# provided.
#spi_bus:
# Select the SPI bus the TMC2660 stepper driver is connected to.
# This depends on the physical connections on your board, as well as
@@ -1670,7 +1701,7 @@
# timeout using a [idle_timeout] config section). The current will
# be raised again once the stepper has to move again. Make sure to
# set this to a high enough value such that the steppers do not lose
-# their position. There is also small delay until the current is
+# their position. There is also small delay until the current is
# raised again, so take this into account when commanding fast moves
# while the stepper is idling. The default is 100 (no reduction).
#driver_TBL: 2
@@ -1938,18 +1969,20 @@
# optional. The cs_pin and a0_pin parameters must be provided when
# using an uc1701 display.
#contrast: 40
-# The contrast to set when using a uc1701 or SSD1306/SH1106 type display
-# For UC1701 the value may range from 0 to 63. Default is 40.
-# For SSD1306/SH1106 the value may range from 0 to 256. Default is 239.
+# The contrast to set when using a uc1701 or SSD1306/SH1106 type
+# display For UC1701 the value may range from 0 to 63. Default is
+# 40. For SSD1306/SH1106 the value may range from 0 to 256. Default
+# is 239.
#vcomh: 0
# Set the Vcomh value on SSD1306/SH1106 displays. This value is
-# associated with a "smearing" effect on some OLED displays.
-# The value may range from 0 to 63. Default is 0.
+# associated with a "smearing" effect on some OLED displays. The
+# value may range from 0 to 63. Default is 0.
#x_offset: 0
-# Set the horizontal offset value on SSD1306/SH1106 displays. Default is 0.
+# Set the horizontal offset value on SSD1306/SH1106 displays.
+# Default is 0.
#invert: FALSE
-# TRUE inverts the pixels on certain OLED (SSD1306/SH1106) displays
-# The default is FALSE
+# TRUE inverts the pixels on certain OLED (SSD1306/SH1106) displays.
+# The default is FALSE.
#cs_pin:
#dc_pin:
#spi_bus:
@@ -1972,53 +2005,61 @@
# _default_20x4 for hd44780 displays and _default_16x4 for other
# displays.
#menu_timeout:
-# Timeout for menu. Being inactive this amount of seconds will trigger
-# menu exit or return to root menu when having autorun enabled.
-# The default is 0 seconds (disabled)
+# Timeout for menu. Being inactive this amount of seconds will
+# trigger menu exit or return to root menu when having autorun
+# enabled. The default is 0 seconds (disabled)
#menu_reverse_navigation:
-# When enabled it will reverse up and down directions for list navigation.
-# The default is False. This parameter is optional.
+# When enabled it will reverse up and down directions for list
+# navigation. The default is False. This parameter is optional.
#encoder_pins:
-# The pins connected to encoder. 2 pins must be provided when
-# using encoder. This parameter must be provided when using menu.
+# The pins connected to encoder. 2 pins must be provided when using
+# encoder. This parameter must be provided when using menu.
#click_pin:
-# The pin connected to 'enter' button or encoder 'click'. This parameter
-# must be provided when using menu. The presence of an 'analog_range_click_pin'
-# config parameter turns this parameter from digital to analog.
+# The pin connected to 'enter' button or encoder 'click'. This
+# parameter must be provided when using menu. The presence of an
+# 'analog_range_click_pin' config parameter turns this parameter
+# from digital to analog.
#back_pin:
-# The pin connected to 'back' button. This parameter is optional, menu
-# can be used without it. The presence of an 'analog_range_back_pin'
-# config parameter turns this parameter from digital to analog.
+# The pin connected to 'back' button. This parameter is optional,
+# menu can be used without it. The presence of an
+# 'analog_range_back_pin' config parameter turns this parameter from
+# digital to analog.
#up_pin:
# The pin connected to 'up' button. This parameter must be provided
-# when using menu without encoder. The presence of an 'analog_range_up_pin'
-# config parameter turns this parameter from digital to analog.
+# when using menu without encoder. The presence of an
+# 'analog_range_up_pin' config parameter turns this parameter from
+# digital to analog.
#down_pin:
-# The pin connected to 'down' button. This parameter must be provided
-# when using menu without encoder. The presence of an 'analog_range_down_pin'
-# config parameter turns this parameter from digital to analog.
+# The pin connected to 'down' button. This parameter must be
+# provided when using menu without encoder. The presence of an
+# 'analog_range_down_pin' config parameter turns this parameter from
+# digital to analog.
#kill_pin:
-# The pin connected to 'kill' button. This button will call emergency stop.
-# The presence of an 'analog_range_kill_pin' config parameter turns this
-# parameter from digital to analog.
+# The pin connected to 'kill' button. This button will call
+# emergency stop. The presence of an 'analog_range_kill_pin' config
+# parameter turns this parameter from digital to analog.
#analog_pullup_resistor: 4700
-# The resistance (in ohms) of the pullup attached to the analog button.
-# The default is 4700 ohms.
+# The resistance (in ohms) of the pullup attached to the analog
+# button. The default is 4700 ohms.
#analog_range_click_pin:
-# The resistance range for a 'enter' button. Range minimum and maximum
-# comma-separated values must be provided when using analog button.
+# The resistance range for a 'enter' button. Range minimum and
+# maximum comma-separated values must be provided when using analog
+# button.
#analog_range_back_pin:
-# The resistance range for a 'back' button. Range minimum and maximum
-# comma-separated values must be provided when using analog button.
+# The resistance range for a 'back' button. Range minimum and
+# maximum comma-separated values must be provided when using analog
+# button.
#analog_range_up_pin:
# The resistance range for a 'up' button. Range minimum and maximum
# comma-separated values must be provided when using analog button.
#analog_range_down_pin:
-# The resistance range for a 'down' button. Range minimum and maximum
-# comma-separated values must be provided when using analog button.
+# The resistance range for a 'down' button. Range minimum and
+# maximum comma-separated values must be provided when using analog
+# button.
#analog_range_kill_pin:
-# The resistance range for a 'kill' button. Range minimum and maximum
-# comma-separated values must be provided when using analog button.
+# The resistance range for a 'kill' button. Range minimum and
+# maximum comma-separated values must be provided when using analog
+# button.
# Support for displaying custom data on an lcd screen. One may create
# any number of display groups and any number of data items under
@@ -2059,8 +2100,8 @@
# Display a custom glyph on displays that support it. The given name
# will be assigned the given display data which can then be referenced
-# in the display templates by their name surrounded by two "tilde" symbols
-# i.e. ~my_display_glyph~
+# in the display templates by their name surrounded by two "tilde"
+# symbols i.e. ~my_display_glyph~
#[display_glyph my_display_glyph]
#data:
# The display data, stored as 16 lines consisting of 16 bits (1 per
@@ -2079,10 +2120,11 @@
# use one of those images in any given screen. This parameter is
# required if hd44780_data is specified.
-# If a primary [display] section has been defined in printer.cfg as shown
-# above it is possible to define multiple auxilary displays. Note that
-# auxilary displays do not currently support menu functionality, thus they
-# do not support the "menu" options or button configuration.
+# If a primary [display] section has been defined in printer.cfg as
+# shown above it is possible to define multiple auxilary displays.
+# Note that auxilary displays do not currently support menu
+# functionality, thus they do not support the "menu" options or button
+# configuration.
#[display my_display]
#lcd_type:
#rs_pin:
@@ -2115,8 +2157,8 @@
# Filament sensors
######################################################################
-# Filament Switch Sensor. Support for filament insert and runout detection
-# using a switch sensor, such as an endstop switch.
+# Filament Switch Sensor. Support for filament insert and runout
+# detection using a switch sensor, such as an endstop switch.
#[filament_switch_sensor my_sensor]
#pause_on_runout: True
# When set to True, a PAUSE will execute immediately after a runout
@@ -2139,7 +2181,7 @@
# ignored. The default is 3 seconds.
#pause_delay: 0.5
# The amount of time to delay, in seconds, between the pause command
-# dispatch and execution of the runout_gcode. It may be useful to
+# dispatch and execution of the runout_gcode. It may be useful to
# increase this delay if Octoprint exhibits strange pause behavior.
# Default is 0.5 seconds.
#switch_pin:
@@ -2150,9 +2192,9 @@
#[tsl1401cl_filament_width_sensor]
#pin: analog5
#default_nominal_filament_diameter: 1.75 # (mm)
-# Maximum allowed filament diameter difference as mm
+# Maximum allowed filament diameter difference as mm.
#max_difference: 0.2
-# The distance from sensor to the melting chamber as mm
+# The distance from sensor to the melting chamber as mm.
#measurement_delay: 100
# Hall filament width sensor (see docs/HallFilamentWidthSensor.md)
@@ -2190,69 +2232,54 @@
# The approximate distance (in mm) between sensor readings. The
# default is 10mm.
#logging: False
-# Out diameter to terminal and klipper.log
-# can be turn on|of by command
-#Virtual filament_switch_sensor support. Create sensor named hall_filament_width_sensor.
-#min_diameter:1.0
-#Minimal diameter for trigger virtual filament_switch_sensor.
+# Out diameter to terminal and klipper.log can be turn on|of by
+# command.
+#min_diameter: 1.0
+# Minimal diameter for trigger virtual filament_switch_sensor.
#use_current_dia_while_delay: False
-# Use the current diameter instead of the nominal diamenter while the measurement delay has not run through.
-#Values from filament_switch_sensor.
-#See [filament_switch_sensor] for a description of these parameters.
-#pause_on_runout: True
-# When set to True, a PAUSE will execute immediately after a runout
-# is detected. Note that if pause_on_runout is False and the
-# runout_gcode is omitted then runout detection is disabled. Default
-# is True.
+# Use the current diameter instead of the nominal diamenter while
+# the measurement delay has not run through.
+#pause_on_runout:
#runout_gcode:
-# A list of G-Code commands to execute after a filament runout is
-# detected. See docs/Command_Templates.md for G-Code format. If
-# pause_on_runout is set to True this G-Code will run after the
-# PAUSE is complete. The default is not to run any G-Code commands.
#insert_gcode:
-# A list of G-Code commands to execute after a filament insert is
-# detected. See docs/Command_Templates.md for G-Code format. The
-# default is not to run any G-Code commands, which disables insert
-# detection.
-#event_delay: 3.0
-# The minimum amount of time in seconds to delay between events.
-# Events triggered during this time period will be silently
-# ignored. The default is 3 seconds.
-#pause_delay: 0.5
-# The amount of time to delay, in seconds, between the pause command
-# dispatch and execution of the runout_gcode. It may be useful to
-# increase this delay if Octoprint exhibits strange pause behavior.
-# Default is 0.5 seconds.
+#event_delay:
+#pause_delay:
+# See [filament_switch_sensor] for a description of the above
+# parameters.
+
######################################################################
# Board specific hardware support
######################################################################
# Configure an SX1509 I2C to GPIO expander. Due to the delay incurred
-# by I2C communication you should NOT use SX1509 pins as stepper enable,
-# step or dir pins or any other pin that requires fast bit-banging. They
-# are best used as static or gcode controlled digital outputs or hardware-pwm
-# pins for e.g. fans. One may define any number of sections with an "sx1509"
-# prefix. Each expander provides a set of 16 pins (sx1509_my_sx1509:PIN_0 to
-# sx1509_my_sx1509:PIN_15) which can be used in the printer configuration.
+# by I2C communication you should NOT use SX1509 pins as stepper
+# enable, step or dir pins or any other pin that requires fast
+# bit-banging. They are best used as static or gcode controlled
+# digital outputs or hardware-pwm pins for e.g. fans. One may define
+# any number of sections with an "sx1509" prefix. Each expander
+# provides a set of 16 pins (sx1509_my_sx1509:PIN_0 to
+# sx1509_my_sx1509:PIN_15) which can be used in the printer
+# configuration.
#[sx1509 my_sx1509]
#i2c_mcu: mcu
+
# The name of the micro-controller that the SX1509 chip is connected
# to. The default is "mcu".
#i2c_address:
-# I2C address used by this expander. Depending on the hardware jumpers
-# this is one out of the following addresses: 62 63 112 113. This
-# parameter must be provided.
+# I2C address used by this expander. Depending on the hardware
+# jumpers this is one out of the following addresses: 62 63 112
+# 113. This parameter must be provided.
#i2c_bus:
# If the I2C implementation of your microcontroller supports
# multiple I2C busses, you may specify the bus name here. The
# default is to use the default micro-controller i2c bus.
-# SAMD SERCOM configuration to specify which pins to use on a given SERCOM.
-# One may define one section with the "samd_sercom" prefix per
-# SERCOM available. Each SERCOM must be configured prior to using it as
-# SPI or I2C peripheral. Place this config section above any other section
-# that makes use of SPI or I2C buses.
+# SAMD SERCOM configuration to specify which pins to use on a given
+# SERCOM. One may define one section with the "samd_sercom" prefix per
+# SERCOM available. Each SERCOM must be configured prior to using it
+# as SPI or I2C peripheral. Place this config section above any other
+# section that makes use of SPI or I2C buses.
#[samd_sercom sercom0]
#tx_pin:
# MOSI pin for SPI communication, or SDA (data) pin for I2C