config: Only document thermistors in example.cfg

Move the common temperature amplifier config descriptions to example-extras.cfg. Also, minor changes to wording of some example-extra.cfg sections. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-10-27 11:50:57 -04:00 · 2019-10-27 11:50:57 -04:00 · 43453131ac
parent 1a69f38e6e
commit 43453131ac
2 changed files with 81 additions and 91 deletions
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@ -236,12 +236,12 @@
 #retries: 0
 #   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.
-# Note the smallest unit of change here would be a single step. However if you
-# are probing more points than steppers then you will likely have a fixed
-# minimum value for the range of probed points which you can learn by observing
-# command output.
+#   If retries are enabled then retry if largest and smallest probed
+#   points differ more than retry_tolerance. Note the smallest unit of
+#   change here would be a single step. However if you are probing
+#   more points than steppers then you will likely have a fixed
+#   minimum value for the range of probed points which you can learn
+#   by observing command output.

 # Moving gantry leveling using 4 independently controlled Z motors.
 # Corrects hyperbolic parabola effects (potato chip) on moving gantry
@ -279,7 +279,7 @@
 #   The height (in mm) that the head should be commanded to move to
 #   just prior to starting a probe operation. The default is 5
 #max_adjust: 4
-#   Saftey limit if an ajustment greater than this value is requested
+#   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
@ -292,7 +292,6 @@
 # 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]


@ -778,81 +777,6 @@
 #   by during the check_gain_time check. It is rare to customize this
 #   value. The default is 2.

-# Custom thermistors (one may define any number of sections with a
-# "thermistor" prefix). A custom thermistor may be used in the
-# sensor_type field of a heater config section. (For example, if one
-# defines a "[thermistor my_thermistor]" section then one may use a
-# "sensor_type: my_thermistor" when defining a heater.) Be sure to
-# place the thermistor section in the config file above its first use
-# in a heater section.
-#[thermistor my_thermistor]
-#temperature1:
-#resistance1:
-#temperature2:
-#resistance2:
-#temperature3:
-#resistance3:
-#   Three resistance measurements (in Ohms) at the given temperatures
-#   (in Celsius). The three measurements will be used to calculate the
-#   Steinhart-Hart coefficients for the thermistor. These parameters
-#   must be provided when using Steinhart-Hart to define the
-#   thermistor.
-#beta:
-#   Alternatively, one may define temperature1, resistance1, and beta
-#   to define the thermistor parameters. This parameter must be
-#   provided when using "beta" to define the thermistor.
-
-# Custom ADC temperature sensors (one may define any number of
-# sections with an "adc_temperature" prefix). This allows one to
-# define a custom temperature sensor that measures a voltage on an
-# Analog to Digital Converter (ADC) pin and uses linear interpolation
-# between a set of configured temperature/voltage (or
-# temperature/resistance) measurements to determine the
-# temperature. The resulting sensor can be used as a sensor_type in a
-# heater section. (For example, if one defines a "[adc_temperature
-# my_sensor]" section then one may use a "sensor_type: my_sensor" when
-# defining a heater.) Be sure to place the sensor section in the
-# config file above its first use in a heater section.
-#[adc_temperature my_sensor]
-#temperature1:
-#voltage1:
-#temperature2:
-#voltage2:
-#...
-#   A set of temperatures (in Celsius) and voltages (in Volts) to use
-#   as reference when converting a temperature. A heater section using
-#   this sensor may also specify an adc_voltage parameter to define
-#   the ADC comparison voltage (see example.cfg for details). At least
-#   two measurements must be provided.
-#temperature1:
-#resistance1:
-#temperature2:
-#resistance2:
-#...
-#   Alternatively one may specify a set of temperatures (in Celsius)
-#   and resistance (in Ohms) to use as reference when converting a
-#   temperature. A heater section using this sensor may also specify a
-#   pullup_resistor parameter (see example.cfg for details). At least
-#   two measurements must be provided.
-
-# AD849x series thermocouple amplifier temperature sensors. The
-# following parameters are available in heater sections that use one
-# of these sensor types.
-#[extruder]
-# See the "extruder" section in example.cfg for a description of
-# heater parameters. The parameters below describe sensor parameters.
-#sensor_type:
-#   One of "AD8494", "AD8495", "AD8496", "AD8497"
-#adc_voltage:
-#   The reference voltage for the ADC pin specified for
-#   sensor_pin. This parameter is required.
-#sensor_pin:
-#   The ADC pin the AD849x device is connected to. This parameter is
-#   required.
-#voltage_offset:
-#   The voltage applied to the REF pin on the AD849x device being
-#   used. The default is 0.
-
 # MAXxxxxx serial peripheral interface (SPI) temperature based
 # sensors. The following parameters are available in heater sections
 # that use one of these sensor types.
@ -887,21 +811,93 @@
 #   chips. The defaults for each parameter are next to the parameter
 #   name in the above list.

-# The heater_generic section is used to describe a custom/generic heater.
-# These behave the same as typical heaters (extruders, heated beds) and
-# can be configured as similarly.
-# However, a gcode_id must be supplied which is used for temperature reporting.
-# See notes on the SET_HEATER_TEMPERATURE command for setting the temperature.
+# Common temperature amplifiers. The following parameters are
+# available in heater sections that use one of these sensors.
+#[extruder]
+# See the "extruder" section in example.cfg for a description of
+# heater parameters. The parameters below describe sensor parameters.
+#sensor_type:
+#   One of "PT100 INA826", "AD595", "AD8494", "AD8495", "AD8496", or
+#   "AD8497".
+#sensor_pin:
+#   Analog input pin connected to the sensor. This parameter must be
+#   provided.
+#adc_voltage: 5.0
+#   The ADC comparison voltage (in Volts). The default is 5 volts.
+#voltage_offset: 0
+#   The ADC voltage offset (in Volts). The default is 0.
+
+# Custom thermistors (one may define any number of sections with a
+# "thermistor" prefix). A custom thermistor may be used in the
+# sensor_type field of a heater config section. (For example, if one
+# defines a "[thermistor my_thermistor]" section then one may use a
+# "sensor_type: my_thermistor" when defining a heater.) Be sure to
+# place the thermistor section in the config file above its first use
+# in a heater section.
+#[thermistor my_thermistor]
+#temperature1:
+#resistance1:
+#temperature2:
+#resistance2:
+#temperature3:
+#resistance3:
+#   Three resistance measurements (in Ohms) at the given temperatures
+#   (in Celsius). The three measurements will be used to calculate the
+#   Steinhart-Hart coefficients for the thermistor. These parameters
+#   must be provided when using Steinhart-Hart to define the
+#   thermistor.
+#beta:
+#   Alternatively, one may define temperature1, resistance1, and beta
+#   to define the thermistor parameters. This parameter must be
+#   provided when using "beta" to define the thermistor.
+
+# Custom ADC temperature sensors (one may define any number of
+# sections with an "adc_temperature" prefix). This allows one to
+# define a custom temperature sensor that measures a voltage on an
+# Analog to Digital Converter (ADC) pin and uses linear interpolation
+# between a set of configured temperature/voltage (or
+# temperature/resistance) measurements to determine the temperature.
+# The resulting sensor can be used as a sensor_type in a heater
+# section. (For example, if one defines a "[adc_temperature
+# my_sensor]" section then one may use a "sensor_type: my_sensor" when
+# defining a heater.) Be sure to place the sensor section in the
+# config file above its first use in a heater section.
+#[adc_temperature my_sensor]
+#temperature1:
+#voltage1:
+#temperature2:
+#voltage2:
+#...
+#   A set of temperatures (in Celsius) and voltages (in Volts) to use
+#   as reference when converting a temperature. A heater section using
+#   this sensor may also specify adc_voltage and voltage_offset
+#   parameters to define the ADC voltage (see "Common temperature
+#   amplifiers" section above for details). At least two measurements
+#   must be provided.
+#temperature1:
+#resistance1:
+#temperature2:
+#resistance2:
+#...
+#   Alternatively one may specify a set of temperatures (in Celsius)
+#   and resistance (in Ohms) to use as reference when converting a
+#   temperature. A heater section using this sensor may also specify a
+#   pullup_resistor parameter (see example.cfg for details). At least
+#   two measurements must be provided.
+
+# Generic heaters (one may define any number of sections with a
+# "heater_generic" prefix). These heaters behave similarly to standard
+# heaters (extruders, heated beds). Use the SET_HEATER_TEMPERATURE
+# command (see docs/G-Codes.md for details) to set the target
+# temperature.
 #[heater_generic my_generic_heater]
 #gcode_id: C
-#    A mandatory parameter that is required for reporting the temperature
-#    through the M105 command.
+#   The id to use when reporting the temperature in the M105 command.
+#   This parameter must be provided.
 #heater_pin:
 #max_power:
 #sensor_type:
 #sensor_pin:
-#pullup_resistor:
-#adc_voltage:
 #smooth_time:
 #control:
 #pid_Kp:
@ -909,14 +905,13 @@
 #pid_Kd:
 #pid_integral_max:
 #pwm_cycle_time:
-#min_extrude_temp:
 #min_temp:
 #max_temp:
 #   See the heater section in example.cfg for the definition of the
 #   above parameters.

-# Temperature sensors. One can define any number of temperature
-# sensors. Their values are reported via the M105 command.
+# Generic temperature sensors. One can define any number of additional
+# temperature sensors that are reported via the M105 command.
 #[temperature_sensor my_sensor]
 #sensor_type:
 #sensor_pin:
--- a/config/example.cfg
+++ b/config/example.cfg
@ -151,28 +151,23 @@ heater_pin: ar10
 #   setting may be used to limit the total power output (over extended
 #   periods) to the heater. The default is 1.0.
 sensor_type: EPCOS 100K B57560G104F
-#   Type of sensor - this may be "EPCOS 100K B57560G104F", "ATC
-#   Semitec 104GT-2", "NTC 100K beta 3950", "Honeywell 100K
-#   135-104LAG-J01", "NTC 100K MGB18-104F39050L32", "AD595", "PT100
-#   INA826", "MAX6675", "MAX31855", "MAX31856", or "MAX31865".
-#   Additional sensor types may be available - see the
-#   example-extras.cfg file for details. This parameter must be
+#   Type of sensor - common thermistors are "EPCOS 100K B57560G104F",
+#   "ATC Semitec 104GT-2", "NTC 100K beta 3950", "Honeywell 100K
+#   135-104LAG-J01", and "NTC 100K MGB18-104F39050L32". See the
+#   example-extras.cfg file for other sensors. This parameter must be
 #   provided.
 sensor_pin: analog13
 #   Analog input pin connected to the sensor. This parameter must be
 #   provided.
 #pullup_resistor: 4700
-#   The resistance (in ohms) of the pullup attached to the
-#   thermistor. This parameter is only valid when the sensor is a
-#   thermistor. The default is 4700 ohms.
+#   The resistance (in ohms) of the pullup attached to the thermistor.
+#   This parameter is only valid when the sensor is a thermistor. The
+#   default is 4700 ohms.
 #inline_resistor: 0
 #   The resistance (in ohms) of an extra (not heat varying) resistor
 #   that is placed inline with the thermistor. It is rare to set this.
 #   This parameter is only valid when the sensor is a thermistor. The
 #   default is 0 ohms.
-#adc_voltage: 5.0
-#   The ADC comparison voltage. This parameter is only valid when the
-#   sensor is an AD595 or "PT100 INA826". The default is 5 volts.
 #smooth_time: 2.0
 #   A time value (in seconds) over which temperature measurements will
 #   be smoothed to reduce the impact of measurement noise. The default