docs: Move config reference information to new Config_Reference.md

Move all the config reference information from files in the config/
directory to a new Config_Reference.md document.

Signed-off-by: Kevin O'Connor <[email protected]>

config/example-cartesian.cfg

@@ -0,0 +1,71 @@
+# This file is an example config file for cartesian style printers.
+# One may copy and edit this file to configure a new cartesian
+# printer.
+
+# DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
+# FIRST. Incorrectly configured parameters may cause damage.
+
+# See docs/Config_Reference.md for a description of parameters.
+
+[stepper_x]
+step_pin: ar54
+dir_pin: ar55
+enable_pin: !ar38
+step_distance: .0225
+endstop_pin: ^ar3
+position_endstop: 0
+position_max: 200
+
+[stepper_y]
+step_pin: ar60
+dir_pin: !ar61
+enable_pin: !ar56
+step_distance: .0225
+endstop_pin: ^ar14
+position_endstop: 0
+position_max: 200
+
+[stepper_z]
+step_pin: ar46
+dir_pin: ar48
+enable_pin: !ar62
+step_distance: .005
+endstop_pin: ^ar18
+position_endstop: 0.5
+position_max: 200
+
+[extruder]
+step_pin: ar26
+dir_pin: ar28
+enable_pin: !ar24
+step_distance: .004242
+nozzle_diameter: 0.500
+filament_diameter: 3.500
+heater_pin: ar10
+sensor_type: EPCOS 100K B57560G104F
+sensor_pin: analog13
+control: pid
+pid_Kp: 22.2
+pid_Ki: 1.08
+pid_Kd: 114
+min_temp: 0
+max_temp: 210
+
+[heater_bed]
+heater_pin: ar8
+sensor_type: EPCOS 100K B57560G104F
+sensor_pin: analog14
+control: watermark
+min_temp: 0
+max_temp: 110
+
+[mcu]
+serial: /dev/ttyACM0
+pin_map: arduino
+
+[printer]
+kinematics: cartesian
+max_velocity: 500
+max_accel: 3000
+max_z_velocity: 25
+max_z_accel: 30

config/example-corexy.cfg

@@ -1,14 +1,12 @@
-# This file serves as documentation for config parameters of corexy
+# This file is an example config file for corexy (and also h-bot)
 # style printers. One may copy and edit this file to configure a new
-# corexy printer. Only parameters unique to corexy printers are
-# described here - see the "example.cfg" file for description of
-# common config parameters.
+# corexy printer.
 
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# The stepper_x section is used to describe the X axis as well as the
-# stepper controlling the X+Y movement.
+# See docs/Config_Reference.md for a description of parameters.
+
 [stepper_x]
 step_pin: ar54
 dir_pin: ar55
@@ -19,8 +17,6 @@ position_endstop: 0
 position_max: 200
 homing_speed: 50
 
-# The stepper_y section is used to describe the Y axis as well as the
-# stepper controlling the X-Y movement.
 [stepper_y]
 step_pin: ar60
 dir_pin: ar61
@@ -74,7 +70,6 @@ pin_map: arduino
 
 [printer]
 kinematics: corexy
-#   This option must be "corexy" for corexy printers.
 max_velocity: 300
 max_accel: 3000
 max_z_velocity: 25

config/example-corexz.cfg

@@ -1,14 +1,11 @@
-# This file serves as documentation for config parameters of corexz
-# style printers. One may copy and edit this file to configure a new
-# corexz printer. Only parameters unique to corexz printers are
-# described here - see the "example.cfg" file for description of common
-# config parameters.
+# This file is an example config file for corexz style printers. One
+# may copy and edit this file to configure a new corexz printer.
 
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# The stepper_x section is used to describe the X axis as well as the
-# stepper controlling the X+Z movement.
+# See docs/Config_Reference.md for a description of parameters.
+
 [stepper_x]
 step_pin: ar54
 dir_pin: ar55
@@ -29,8 +26,6 @@ position_endstop: 0
 position_max: 200
 homing_speed: 50
 
-# The stepper_z section is used to describe the Z axis as well as the
-# stepper controlling the X-Z movement.
 [stepper_z]
 step_pin: ar46
 dir_pin: ar48
@@ -74,7 +69,6 @@ pin_map: arduino
 
 [printer]
 kinematics: corexz
-#   This option must be "corexz" for corexz printers.
 max_velocity: 300
 max_accel: 3000
 max_z_velocity: 50

config/example-delta.cfg

@@ -1,15 +1,11 @@
-# This file serves as documentation for config parameters of delta
-# style printers. One may copy and edit this file to configure a new
-# delta printer. Only parameters unique to delta printers are
-# described here - see the "example.cfg" file for description of
-# common config parameters.
+# This file is an example config file for linear delta style printers.
+# One may copy and edit this file to configure a new delta printer.
 
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# The stepper_a section describes the stepper controlling the front
-# left tower (at 210 degrees). This section also controls the homing
-# parameters (homing_speed, homing_retract_dist) for all towers.
+# See docs/Config_Reference.md for a description of parameters.
+
 [stepper_a]
 step_pin: ar54
 dir_pin: ar55
@@ -18,32 +14,15 @@ step_distance: .01
 endstop_pin: ^ar2
 homing_speed: 50
 position_endstop: 297.05
-#   Distance (in mm) between the nozzle and the bed when the nozzle is
-#   in the center of the build area and the endstop triggers. This
-#   parameter must be provided for stepper_a; for stepper_b and
-#   stepper_c this parameter defaults to the value specified for
-#   stepper_a.
 arm_length: 333.0
-#   Length (in mm) of the diagonal rod that connects this tower to the
-#   print head. This parameter must be provided for stepper_a; for
-#   stepper_b and stepper_c this parameter defaults to the value
-#   specified for stepper_a.
-#angle:
-#   This option specifies the angle (in degrees) that the tower is
-#   at. The default is 210 for stepper_a, 330 for stepper_b, and 90
-#   for stepper_c.
 
-# The stepper_b section describes the stepper controlling the front
-# right tower (at 330 degrees).
 [stepper_b]
 step_pin: ar60
 dir_pin: ar61
 enable_pin: !ar56
 step_distance: .01
 endstop_pin: ^ar15
 
-# The stepper_c section describes the stepper controlling the rear
-# tower (at 90 degrees).
 [stepper_c]
 step_pin: ar46
 dir_pin: ar48
@@ -76,57 +55,16 @@ control: watermark
 min_temp: 0
 max_temp: 130
 
-# Print cooling fan (omit section if fan not present).
-#[fan]
-#pin: ar9
-
 [mcu]
 serial: /dev/ttyACM0
 pin_map: arduino
 
 [printer]
 kinematics: delta
-#   This option must be "delta" for linear delta printers.
 max_velocity: 300
-#   Maximum velocity (in mm/s) of the toolhead relative to the
-#   print. This parameter must be specified.
 max_accel: 3000
-#   Maximum acceleration (in mm/s^2) of the toolhead relative to the
-#   print. This parameter must be specified.
 max_z_velocity: 150
-#   For delta printers this limits the maximum velocity (in mm/s) of
-#   moves with z axis movement. This setting can be used to reduce the
-#   maximum speed of up/down moves (which require a higher step rate
-#   than other moves on a delta printer). The default is to use
-#   max_velocity for max_z_velocity.
-#minimum_z_position: 0
-#   The minimum Z position that the user may command the head to move
-#   to.  The default is 0.
 delta_radius: 174.75
-#   Radius (in mm) of the horizontal circle formed by the three linear
-#   axis towers. This parameter may also be calculated as:
-#    delta_radius = smooth_rod_offset - effector_offset - carriage_offset
-#   This parameter must be provided.
-#print_radius:
-#   The radius (in mm) of valid toolhead XY coordinates. One may use
-#   this setting to customize the range checking of toolhead moves. If
-#   a large value is specified here then it may be possible to command
-#   the toolhead into a collision with a tower. The default is to use
-#   delta_radius for print_radius (which would normally prevent a
-#   tower collision).
 
-# The delta_calibrate section enables a DELTA_CALIBRATE extended
-# g-code command that can calibrate the tower endstop positions and
-# angles.
 [delta_calibrate]
 radius: 50
-#   Radius (in mm) of the area that may be probed. This is the radius
-#   of nozzle coordinates to be probed; if using an automatic probe
-#   with an XY offset then choose a radius small enough so that the
-#   probe always fits over the bed. This parameter must be provided.
-#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.

config/example-polar.cfg

@@ -1,27 +1,17 @@
-# This file serves as documentation for config parameters of "polar"
-# style printers. One may copy and edit this file to configure a new
-# polar printer.
+# This file is an example config file for polar style printers. One
+# may copy and edit this file to configure a new polar printer.
 
 # POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the 0,0
 # position are known to not work properly.
 
-# Only parameters unique to polar printers are described here - see
-# the "example.cfg" file for description of common config parameters.
+# See docs/Config_Reference.md for a description of parameters.
 
-# The stepper_bed section is used to describe the stepper controlling
-# the bed.
 [stepper_bed]
 step_pin: ar54
 dir_pin: ar55
 enable_pin: !ar38
 step_distance: 0.001963495
-#   On a polar printer the step_distance is the amount each step pulse
-#   moves the bed in radians (for example, a 1.8 degree stepper with
-#   16 micro-steps would be 2 * pi * (1.8 / 360) / 16 == 0.001963495).
-#   This parameter must be provided.
 
-# The stepper_arm section is used to describe the stepper controlling
-# the carriage on the arm.
 [stepper_arm]
 step_pin: ar60
 dir_pin: ar61
@@ -32,8 +22,6 @@ position_endstop: 300
 position_max: 300
 homing_speed: 50
 
-# The stepper_z section is used to describe the stepper controlling
-# the Z axis.
 [stepper_z]
 step_pin: ar46
 dir_pin: ar48
@@ -77,7 +65,6 @@ pin_map: arduino
 
 [printer]
 kinematics: polar
-#   This option must be "polar" for polar printers.
 max_velocity: 300
 max_accel: 3000
 max_z_velocity: 25