diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/BLTouch.md | 2 | ||||
| -rw-r--r-- | docs/Bed_Mesh.md | 52 | ||||
| -rw-r--r-- | docs/Command_Templates.md | 2 | ||||
| -rw-r--r-- | docs/Config_Reference.md | 88 | ||||
| -rw-r--r-- | docs/G-Codes.md | 2 | ||||
| -rw-r--r-- | docs/Manual_Level.md | 30 | ||||
| -rw-r--r-- | docs/Measuring_Resonances.md | 2 | ||||
| -rw-r--r-- | docs/Probe_Calibrate.md | 2 | ||||
| -rw-r--r-- | docs/Rotation_Distance.md | 2 |
9 files changed, 91 insertions, 91 deletions
diff --git a/docs/BLTouch.md b/docs/BLTouch.md index 4445a6a5..9d6a7983 100644 --- a/docs/BLTouch.md +++ b/docs/BLTouch.md @@ -28,7 +28,7 @@ move to the center of the bed, and home the z axis. For example: ``` [safe_z_home] -home_xy_position: 100,100 # Change coordinates to the center of your print bed +home_xy_position: 100, 100 # Change coordinates to the center of your print bed speed: 50 z_hop: 10 # Move up 10mm z_hop_speed: 5 diff --git a/docs/Bed_Mesh.md b/docs/Bed_Mesh.md index 4b70b892..34ac2768 100644 --- a/docs/Bed_Mesh.md +++ b/docs/Bed_Mesh.md @@ -24,9 +24,9 @@ bed and a probe with an x-offset of 24 mm and y-offset of 5 mm. [bed_mesh] speed: 120 horizontal_move_z: 5 -mesh_min: 35,6 +mesh_min: 35, 6 mesh_max: 240, 198 -probe_count: 5,3 +probe_count: 5, 3 ``` - `speed: 120`\ @@ -37,21 +37,21 @@ probe_count: 5,3 _Default Value: 5_\ The Z coordinate the probe rises to prior to traveling between points. -- `mesh_min: 35,6`\ +- `mesh_min: 35, 6`\ _Required_\ The first probed coordinate, nearest to the origin. This coordinate is relative to the probe's location. -- `mesh_max: 240,198`\ +- `mesh_max: 240, 198`\ _Required_\ The probed coordinate farthest farthest from the origin. This is not necessarily the last point probed, as the probing process occurs in a zig-zag fashion. As with `mesh_min`, this coordiante is relative to the probe's location. -- `probe_count: 5,3`\ - _Default Value: 3,3_\ - The number of points to probe on each axis, specified as x,y integer +- `probe_count: 5, 3`\ + _Default Value: 3, 3_\ + The number of points to probe on each axis, specified as X, Y integer values. In this example 5 points will be probed along the X axis, with 3 points along the Y axis, for a total of 15 probed points. Note that if you wanted a square grid, for example 3x3, this could be specified @@ -76,7 +76,7 @@ and 5 mm on Y. speed: 120 horizontal_move_z: 5 mesh_radius: 75 -mesh_origin: 0,0 +mesh_origin: 0, 0 round_probe_count: 5 ``` @@ -86,10 +86,10 @@ round_probe_count: 5 that the probe's offsets limit the size of the mesh radius. In this example, a radius larger than 76 would move the tool beyond the range of the printer. -- `mesh_origin: 0,0`\ - _Default Value: 0,0_\ +- `mesh_origin: 0, 0`\ + _Default Value: 0, 0_\ The center point of the mesh. This coordinate is relative to the probe's - location. While the default is 0,0, it may be useful to adjust the origin + location. While the default is 0, 0, it may be useful to adjust the origin in an effort to probe a larger portion of the bed. See the illustration below. @@ -125,20 +125,20 @@ lagrange and bicubic interpolation to accomplish this. [bed_mesh] speed: 120 horizontal_move_z: 5 -mesh_min: 35,6 +mesh_min: 35, 6 mesh_max: 240, 198 -probe_count: 5,3 -mesh_pps: 2,3 +probe_count: 5, 3 +mesh_pps: 2, 3 algorithm: bicubic bicubic_tension: 0.2 ``` -- `mesh_pps: 2,3`\ - _Default Value: 2,2_\ +- `mesh_pps: 2, 3`\ + _Default Value: 2, 2_\ The `mesh_pps` option is shorthand for Mesh Points Per Segment. This option specifies how many points to interpolate for each segment along - the x and y axes. Consider a 'segment' to be the space between each - probed point. Like `probe_count`, `mesh_pps` is specified as an x,y + the X and Y axes. Consider a 'segment' to be the space between each + probed point. Like `probe_count`, `mesh_pps` is specified as an X, Y integer pair, and also may be specified a single integer that is applied to both axes. In this example there are 4 segments along the X axis and 2 segments along the Y axis. This evaluates to 8 interpolated @@ -179,9 +179,9 @@ control the splitting behavior. [bed_mesh] speed: 120 horizontal_move_z: 5 -mesh_min: 35,6 +mesh_min: 35, 6 mesh_max: 240, 198 -probe_count: 5,3 +probe_count: 5, 3 move_check_distance: 5 split_delta_z: .025 ``` @@ -225,9 +225,9 @@ As such, fade is disabled by default. [bed_mesh] speed: 120 horizontal_move_z: 5 -mesh_min: 35,6 +mesh_min: 35, 6 mesh_max: 240, 198 -probe_count: 5,3 +probe_count: 5, 3 fade_start: 1 fade_end: 10 fade_target: 0 @@ -273,9 +273,9 @@ These printers can benefit from configuring the relative reference index. [bed_mesh] speed: 120 horizontal_move_z: 5 -mesh_min: 35,6 +mesh_min: 35, 6 mesh_max: 240, 198 -probe_count: 5,3 +probe_count: 5, 3 relative_reference_index: 7 ``` @@ -314,9 +314,9 @@ will be averaged and inserted in the mesh as the Z value at the generated [bed_mesh] speed: 120 horizontal_move_z: 5 -mesh_min: 35,6 +mesh_min: 35, 6 mesh_max: 240, 198 -probe_count: 5,3 +probe_count: 5, 3 faulty_region_1_min: 130.0, 0.0 faulty_region_1_max: 145.0, 40.0 faulty_region_2_min: 225.0, 0.0 diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md index 732ed1a1..7d5b229e 100644 --- a/docs/Command_Templates.md +++ b/docs/Command_Templates.md @@ -95,7 +95,7 @@ gcode: G90 G0 Z15 F300 {% for wipe in range(wipe_count) %} - {% for coordinate in [(275,4),(235,4)] %} + {% for coordinate in [(275, 4),(235, 4)] %} G0 X{coordinate[0]} Y{coordinate[1] + 0.25 * wipe} Z9.7 F12000 {% endfor %} {% endfor %} diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index fbd929b6..d344310a 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -462,7 +462,7 @@ Only parameters specific to polar printers are described here - see [common kinematic settings](#common-kinematic-settings) for available parameters. -POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the `0,0` +POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the 0, 0 position are known to not work properly. ``` @@ -597,7 +597,7 @@ available parameters. CABLE WINCH SUPPORT IS EXPERIMENTAL. Homing is not implemented on cable winch kinematics. In order to home the printer, manually send -movement commands until the toolhead is at 0,0,0 and then issue a +movement commands until the toolhead is at 0, 0, 0 and then issue a `G28` command. ``` @@ -615,7 +615,7 @@ rotation_distance: anchor_x: anchor_y: anchor_z: -# The x, y, and z position of the cable winch in cartesian space. +# The X, Y, and Z position of the cable winch in cartesian space. # These parameters must be provided. ``` @@ -793,7 +793,7 @@ information. Visual Examples: ``` - rectangular bed, probe_count = 3,3: + rectangular bed, probe_count = 3, 3: x---x---x (max_point) | x---x---x @@ -801,15 +801,15 @@ Visual Examples: (min_point) x---x---x round bed, round_probe_count = 5, bed_radius = r: - x (0,r) end - / - x---x---x - \ - (-r,0) x---x---x---x---x (r,0) - \ - x---x---x - / - x (0,-r) start + x (0, r) end + / + x---x---x + \ + (-r, 0) x---x---x---x---x (r, 0) + \ + x---x---x + / + x (0, -r) start ``` ``` @@ -826,26 +826,26 @@ Visual Examples: # 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 +# 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 coordinate of the mesh for rectangular +# Defines the minimum X, Y coordinate 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 +# 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 +#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 +# 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. +# 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. @@ -871,12 +871,12 @@ Visual Examples: # 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 # is 5.0. -#mesh_pps: 2,2 -# A comma separated pair of integers (X,Y) defining the number of +#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. +# 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 @@ -916,12 +916,12 @@ information. # axis. The default is 0. #z_adjust: 0 # The amount to add to the Z height when the nozzle is nominally at -# 0,0. The default is 0. +# 0, 0. The default is 0. # The remaining parameters control a BED_TILT_CALIBRATE extended # g-code command that may be used to calibrate appropriate x and y # adjustment parameters. #points: -# A list of X,Y coordinates (one per line; subsequent lines +# A list of X, Y coordinates (one per line; subsequent lines # indented) that should be probed during a BED_TILT_CALIBRATE # command. Specify coordinates of the nozzle and be sure the probe # is above the bed at the given nozzle coordinates. The default is @@ -947,7 +947,7 @@ information. ``` [bed_screws] #screw1: -# The X,Y coordinate of the first bed leveling screw. This is a +# The X, Y coordinate of the first bed leveling screw. This is a # position to command the nozzle to that is directly above the bed # screw (or as close as possible while still being above the bed). # This parameter must be provided. @@ -956,7 +956,7 @@ information. # the helper script runs. The default is to use a name based upon # the screw XY location. #screw1_fine_adjust: -# An X,Y coordinate to command the nozzle to so that one can fine +# An X, Y coordinate to command the nozzle to so that one can fine # tune the bed leveling screw. The default is to not perform fine # adjustments on the bed screw. #screw2: @@ -993,7 +993,7 @@ additional information. ``` [screws_tilt_adjust] #screw1: -# The X,Y coordinate of the first bed leveling screw. This is a +# The (X, Y) coordinate of the first bed leveling screw. This is a # position to command the nozzle to that is directly above the bed # screw (or as close as possible while still being above the bed). # This is the base screw used in calculations. This parameter must @@ -1032,15 +1032,15 @@ extended [G-Code command](G-Codes.md#z-tilt) becomes available. ``` [z_tilt] #z_positions: -# A list of X,Y coordinates (one per line; subsequent lines +# A list of X, Y coordinates (one per line; subsequent lines # indented) describing the location of each bed "pivot point". The # "pivot point" is the point where the bed attaches to the given Z -# stepper. It is described using nozzle coordinates (the XY position +# stepper. It is described using nozzle coordinates (the X, Y position # of the nozzle if it could move directly above the point). The # first entry corresponds to stepper_z, the second to stepper_z1, # the third to stepper_z2, etc. This parameter must be provided. #points: -# A list of X,Y coordinates (one per line; subsequent lines +# A list of X, Y coordinates (one per line; subsequent lines # indented) that should be probed during a Z_TILT_ADJUST command. # Specify coordinates of the nozzle and be sure the probe is above # the bed at the given nozzle coordinates. This parameter must be @@ -1082,16 +1082,16 @@ configuration: |Z Z3| ---------------- ``` -Where x is the (0,0) point on the bed +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 +# 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 +# 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, @@ -1131,13 +1131,13 @@ the nature of skew correction these lengths are set via gcode. See ### [safe_z_home] Safe Z homing. One may use this mechanism to home the Z axis at a -specific XY coordinate. This is useful if the toolhead, for example +specific X, Y coordinate. This is useful if the toolhead, for example has to move to the center of the bed before Z can be homed. ``` [safe_z_home] home_xy_position: -# A X,Y coordinate (e.g. 100,100) where the Z homing should be +# A X, Y coordinate (e.g. 100, 100) where the Z homing should be # performed. This parameter must be provided. #speed: 50.0 # Speed at which the toolhead is moved to the safe Z home @@ -1153,8 +1153,8 @@ home_xy_position: # Speed (in mm/s) 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, the X and Y axes are reset to their previous +# positions after Z axis homing. The default is False. ``` ### [homing_override] @@ -1489,13 +1489,13 @@ cs_pin: #spi_software_miso_pin: # See the "common SPI settings" section for a description of the # above parameters. -#axes_map: x,y,z -# The accelerometer axis for each of the printer's x, y, and z axes. +#axes_map: x, y, z +# The accelerometer axis for each of the printer's X, Y, and Z axes. # This may be useful if the accelerometer is mounted in an # orientation that does not match the printer orientation. For -# example, one could set this to "y,x,z" to swap the x and y axes. +# example, one could set this to "y, x, z" to swap the X and Y axes. # It is also possible to negate an axis if the accelerometer -# direction is reversed (eg, "x,z,-y"). The default is "x,y,z". +# 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 @@ -1518,7 +1518,7 @@ section of the measuring resonances guide for more information on ``` [resonance_tester] #probe_points: -# A list of X,Y,Z coordinates of points (one point per line) to test +# 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. @@ -3891,7 +3891,7 @@ example. ``` # The "replicape" config section adds "replicape:stepper_x_enable" -# virtual stepper enable pins (for steppers x, y, z, e, and h) and +# virtual stepper enable pins (for steppers X, Y, Z, E, and H) and # "replicape:power_x" PWM output pins (for hotbed, e, h, fan0, fan1, # fan2, and fan3) that may then be used elsewhere in the config file. [replicape] diff --git a/docs/G-Codes.md b/docs/G-Codes.md index 12070f1d..b4cb63a3 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -445,7 +445,7 @@ The following commands are available when the available while this tool is active. - `BED_MESH_OUTPUT PGP=[<0:1>]`: This command outputs the current probed z values and current mesh values to the terminal. If PGP=1 is specified - the x,y coordinates generated by bed_mesh, along with their associated + the X, Y coordinates generated by bed_mesh, along with their associated indices, will be output to the terminal. - `BED_MESH_MAP`: Like to BED_MESH_OUTPUT, this command prints the current state of the mesh to the terminal. Instead of printing the values in a diff --git a/docs/Manual_Level.md b/docs/Manual_Level.md index 6a49d499..2b73e8b4 100644 --- a/docs/Manual_Level.md +++ b/docs/Manual_Level.md @@ -63,9 +63,9 @@ This is done by creating a `[bed_screws]` config section. For example, it might look something similar to: ``` [bed_screws] -screw1: 100,50 -screw2: 100,150 -screw3: 150,100 +screw1: 100, 50 +screw2: 100, 150 +screw3: 150, 100 ``` If a bed screw is under the bed, then specify the XY position directly @@ -79,8 +79,8 @@ then one can start the tool by running: BED_SCREWS_ADJUST ``` -This tool will move the printer's nozzle to each screw XY location and -then move the nozzle to a Z=0 height. At this point one can use the +This tool will move the printer's nozzle to each screw XY location +and then move the nozzle to a Z=0 height. At this point one can use the "paper test" to adjust the bed screw directly under the nozzle. See the information described in ["the paper test"](Bed_Level.md#the-paper-test), but adjust the bed @@ -126,12 +126,12 @@ coordinates and add them to the config file. For example, it might look like: ``` [bed_screws] -screw1: 100,50 -screw1_fine_adjust: 0,0 -screw2: 100,150 -screw2_fine_adjust: 300,300 -screw3: 150,100 -screw3_fine_adjust: 0,100 +screw1: 100, 50 +screw1_fine_adjust: 0, 0 +screw2: 100, 150 +screw2_fine_adjust: 300, 300 +screw3: 150, 100 +screw3_fine_adjust: 0, 100 ``` When this feature is enabled, the `BED_SCREWS_ADJUST` tool will first @@ -151,13 +151,13 @@ config file. For example, it might look like: ``` [screws_tilt_adjust] -screw1: -5,30 +screw1: -5, 30 screw1_name: front left screw -screw2: 155,30 +screw2: 155, 30 screw2_name: front right screw -screw3: 155,190 +screw3: 155, 190 screw3_name: rear right screw -screw4: -5,190 +screw4: -5, 190 screw4_name: rear left screw horizontal_move_z: 10. speed: 50. diff --git a/docs/Measuring_Resonances.md b/docs/Measuring_Resonances.md index 32a7413d..f829a082 100644 --- a/docs/Measuring_Resonances.md +++ b/docs/Measuring_Resonances.md @@ -98,7 +98,7 @@ cs_pin: rpi:None [resonance_tester] accel_chip: adxl345 probe_points: - 100,100,20 # an example + 100, 100, 20 # an example ``` It is advised to start with 1 probe point, in the middle of the print bed, slightly above it. diff --git a/docs/Probe_Calibrate.md b/docs/Probe_Calibrate.md index 3531d13c..9bede889 100644 --- a/docs/Probe_Calibrate.md +++ b/docs/Probe_Calibrate.md @@ -1,6 +1,6 @@ # Probe calibration -This document describes the method for calibrating the x, y, and z +This document describes the method for calibrating the X, Y, and Z offsets of an "automatic z probe" in Klipper. This is useful for users that have a `[probe]` or `[bltouch]` section in their config file. diff --git a/docs/Rotation_Distance.md b/docs/Rotation_Distance.md index c2411a8a..142fe250 100644 --- a/docs/Rotation_Distance.md +++ b/docs/Rotation_Distance.md @@ -36,7 +36,7 @@ Most drivers use 16 microsteps. If unsure, set `microsteps: 16` in the config and use 16 in the formula above. Almost all printers should have a whole number for `rotation_distance` -on x, y, and z type axes. If the above formula results in a +on X, Y, and Z type axes. If the above formula results in a rotation_distance that is within .01 of a whole number then round the final value to that whole_number. |