docs: Docs comma culture (#4822)

Many non-English speaking countries use a comma as a decimal separator for printed numbers. This can create some confusion in documentation and config files when not surrounded by contextual clues like parenthesis.  Improve documentation by adding spaces to coordinates.

Signed-off-by: Paul McGowan <mental450@gmail.com>
This commit is contained in:
Paul McGowan 2022-01-09 21:13:53 -05:00 committed by GitHub
parent 4c8d24ae03
commit de366ee854
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 201 additions and 201 deletions

View File

@ -1,7 +1,7 @@
# This file is an example config file for polar style printers. One # This file is an example config file for polar style printers. One
# may copy and edit this file to configure a new polar printer. # may copy and edit this file to configure a new polar printer.
# 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. # position are known to not work properly.
# See docs/Config_Reference.md for a description of parameters. # See docs/Config_Reference.md for a description of parameters.

View File

@ -6,7 +6,7 @@
# Homing is not implemented on cable winch kinematics. In order to # Homing is not implemented on cable winch kinematics. In order to
# home the printer, manually send movement commands until the toolhead # home the printer, manually send movement commands until the toolhead
# is at 0,0,0 and then issue a G28 command. # is at 0, 0, 0 and then issue a G28 command.
# See docs/Config_Reference.md for a description of parameters. # See docs/Config_Reference.md for a description of parameters.

View File

@ -227,14 +227,14 @@ gcode:
[quad_gantry_level] [quad_gantry_level]
# Use QUAD_GANTRY_LEVEL to level a gantry. # Use QUAD_GANTRY_LEVEL to level a gantry.
gantry_corners: gantry_corners:
-55,-7 -55, -7
305, 320 305, 320
# Min & Max gantry corners - measure from nozzle at MIN (0,0) and MAX (250,250) to respective belt positions # Min & Max gantry corners - measure from nozzle at MIN (0,0) and MAX (250,250) to respective belt positions
points: points:
25,0 25, 0
25,200 25, 200
225,200 225, 200
225,0 225, 0
# Probe points # Probe points
speed: 200 speed: 200
horizontal_move_z: 6 horizontal_move_z: 6

View File

@ -134,9 +134,9 @@ sample_retract_dist: 3.0
[bed_mesh] [bed_mesh]
speed: 100 speed: 100
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 69,41 mesh_min: 69, 41
mesh_max: 189,161 mesh_max: 189, 161
probe_count: 3,3 probe_count: 3, 3
[homing_override] [homing_override]
set_position_z: 6 set_position_z: 6

View File

@ -132,10 +132,10 @@ max_z_accel: 50
square_corner_velocity: 5 square_corner_velocity: 5
[bed_screws] [bed_screws]
screw1: 5,5 screw1: 5, 5
screw2: 265,210 screw2: 265, 210
screw3: 5,210 screw3: 5, 210
screw4: 265,5 screw4: 265, 5
[filament_switch_sensor filament_sensor] [filament_switch_sensor filament_sensor]
switch_pin: ^!PC4 switch_pin: ^!PC4

View File

@ -64,7 +64,7 @@ speed: 3.0
samples: 1 samples: 1
[safe_z_home] [safe_z_home]
home_xy_position: 117,117 home_xy_position: 117, 117
speed: 50.0 speed: 50.0
z_hop: 10.0 z_hop: 10.0
z_hop_speed: 100 z_hop_speed: 100
@ -72,9 +72,9 @@ z_hop_speed: 100
[bed_mesh] [bed_mesh]
speed: 100 speed: 100
horizontal_move_z: 8 horizontal_move_z: 8
mesh_min: 106,39 mesh_min: 106, 39
mesh_max: 281,229 mesh_max: 281, 229
probe_count: 3,3 probe_count: 3, 3
[heater_bed] [heater_bed]
heater_pin: PH5 heater_pin: PH5

View File

@ -75,8 +75,8 @@ pin_up_touch_mode_reports_triggered: False
speed: 100 speed: 100
horizontal_move_z: 8 horizontal_move_z: 8
mesh_min: 50, 50 mesh_min: 50, 50
mesh_max: 300,300 mesh_max: 300, 300
probe_count: 3,3 probe_count: 3, 3
[heater_bed] [heater_bed]
heater_pin: PH5 heater_pin: PH5

View File

@ -75,7 +75,7 @@ position_max: 400
# mesh_min: 10, 10 # mesh_min: 10, 10
# mesh_max: 239, 239 # mesh_max: 239, 239
# algorithm: bicubic # algorithm: bicubic
# probe_count: 5,5 # probe_count: 5, 5
[extruder] [extruder]
max_extrude_only_distance: 1000.0 max_extrude_only_distance: 1000.0

View File

@ -113,7 +113,7 @@ restart_method: command
# mesh_min: 20, 15 # mesh_min: 20, 15
# mesh_max: 250, 240 # mesh_max: 250, 240
# algorithm: bicubic # algorithm: bicubic
# probe_count: 5,5 # probe_count: 5, 5
[filament_switch_sensor filament_sensor] [filament_switch_sensor filament_sensor]
pause_on_runout: true pause_on_runout: true

View File

@ -141,15 +141,15 @@ z_offset: 2.6
pin_up_touch_mode_reports_triggered: False pin_up_touch_mode_reports_triggered: False
[safe_z_home] [safe_z_home]
home_xy_position: 5,5 home_xy_position: 5, 5
z_hop: 5.0 z_hop: 5.0
z_hop_speed: 5.0 z_hop_speed: 5.0
[bed_mesh] [bed_mesh]
speed: 80 speed: 80
mesh_min: 40,20 mesh_min: 40, 20
mesh_max: 210,205 mesh_max: 210, 205
probe_count: 5,5 probe_count: 5, 5
###################################################################### ######################################################################
# "RepRapDiscount 128x64 Full Graphic Smart Controller" type display # "RepRapDiscount 128x64 Full Graphic Smart Controller" type display

View File

@ -42,10 +42,10 @@ max_z_velocity: 25
max_z_accel: 100 max_z_accel: 100
[bed_screws] [bed_screws]
screw1: 33,33 screw1: 33, 33
screw2: 203,33 screw2: 203, 33
screw3: 203,201 screw3: 203, 201
screw4: 33,201 screw4: 33, 201
[stepper_x] [stepper_x]
step_pin: PE3 step_pin: PE3
@ -158,7 +158,7 @@ switch_pin: !PA4
# Optional bed mesh configuration you can use if you have a BLtouch installed. # Optional bed mesh configuration you can use if you have a BLtouch installed.
#[bed_mesh] #[bed_mesh]
#mesh_min: 70,15 #mesh_min: 70, 15
#mesh_max: 220,210 #mesh_max: 220, 210
#horizontal_move_z: 5 #horizontal_move_z: 5
#speed: 150 #speed: 150

View File

@ -93,9 +93,9 @@ speed: 5
######################################## ########################################
[bed_mesh] [bed_mesh]
mesh_min: 40,40 mesh_min: 40, 40
mesh_max: 185,230 mesh_max: 185, 230
probe_count: 4,4 probe_count: 4, 4
speed: 100 speed: 100
fade_end: 0.0 fade_end: 0.0
algorithm: bicubic algorithm: bicubic

View File

@ -65,9 +65,9 @@ position_max: 250
# z_offset: 1.56 # z_offset: 1.56
# [bed_mesh] # [bed_mesh]
# mesh_min: 16,16 # mesh_min: 16, 16
# mesh_max: 201,200 # mesh_max: 201, 200
# probe_count: 4,3 # probe_count: 4, 3
[extruder] [extruder]
step_pin: PA4 step_pin: PA4

View File

@ -197,10 +197,10 @@ samples_tolerance_retries: 2
[bed_tilt] [bed_tilt]
# Enable bed tilt measurments using the probe we defined above # Enable bed tilt measurments using the probe we defined above
# Probe points using X0 Y0 offsets @ 0.01mm/step # Probe points using X0 Y0 offsets @ 0.01mm/step
points: -2,-6 points: -2, -6
156,-6 156, -6
156,158 156, 158
-2,158 -2, 158
speed: 75 speed: 75
horizontal_move_z: 2 horizontal_move_z: 2

View File

@ -151,15 +151,15 @@ sample_retract_dist: 1.0
samples_tolerance: 0.075 samples_tolerance: 0.075
[bed_tilt] [bed_tilt]
points: -9,-9 points: -9, -9
289.4,-9 289.4, -9
289.4,290 289.4, 290
-9,289 -9, 289
speed: 75 speed: 75
horizontal_move_z: 5 horizontal_move_z: 5
[safe_z_home] [safe_z_home]
home_xy_position: -19.1,259.3 home_xy_position: -19.1, 259.3
speed: 50.0 speed: 50.0
z_hop: 10.0 z_hop: 10.0

View File

@ -185,10 +185,10 @@ samples_tolerance: 0.100
[bed_tilt] [bed_tilt]
#Enable bed tilt measurments using the probe we defined above #Enable bed tilt measurments using the probe we defined above
#Probe points using X0 Y0 offsets @ 0.01mm/step #Probe points using X0 Y0 offsets @ 0.01mm/step
points: -3,-6 points: -3, -6
282,-6 282, -6
282,300 282, 300
-3,300 -3, 300
speed: 75 speed: 75
horizontal_move_z: 5 horizontal_move_z: 5
@ -196,7 +196,7 @@ horizontal_move_z: 5
#Needed to lift the Z to clear homing switch on bed #Needed to lift the Z to clear homing switch on bed
# ---> WARNING! - Z_MAX limit switch not monitored in Klipper! <--- # ---> WARNING! - Z_MAX limit switch not monitored in Klipper! <---
# ---> This could potentially crash the toolhead if already at the top of Z travel! <--- # ---> This could potentially crash the toolhead if already at the top of Z travel! <---
home_xy_position: -19,265 home_xy_position: -19, 265
speed: 50.0 speed: 50.0
z_hop: 15.0 z_hop: 15.0
move_to_previous: False move_to_previous: False

View File

@ -143,10 +143,10 @@ max_z_accel: 20
# Positions for BED_SCREWS_ADJUST levelling with bed screws still accessible # Positions for BED_SCREWS_ADJUST levelling with bed screws still accessible
[bed_screws] [bed_screws]
screw1: 22,10 screw1: 22, 10
screw2: 22,90 screw2: 22, 90
screw3: 98,90 screw3: 98, 90
screw4: 98,10 screw4: 98, 10
###################################################################### ######################################################################
# Optional: i2c ssd1306 OLED-display controlled by raspi host_mcu # Optional: i2c ssd1306 OLED-display controlled by raspi host_mcu

View File

@ -93,13 +93,13 @@ y_offset: 37
z_offset: 2.0 z_offset: 2.0
[safe_z_home] [safe_z_home]
home_xy_position: 125,150 home_xy_position: 125, 150
z_hop: 10 z_hop: 10
z_hop_speed: 5 z_hop_speed: 5
[bed_mesh] [bed_mesh]
mesh_min: 5,5 mesh_min: 5, 5
mesh_max: 225,225 mesh_max: 225, 225
[fan] [fan]
pin: PH5 pin: PH5

View File

@ -158,15 +158,15 @@ z_offset: 0 # set this to your Live Z Offset, but negated (invert the sign)
speed: 6.0 speed: 6.0
[safe_z_home] [safe_z_home]
home_xy_position: 147.4,21.1 home_xy_position: 147.4, 21.1
z_hop: 4 z_hop: 4
[bed_mesh] [bed_mesh]
speed: 100 speed: 100
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 10,10 mesh_min: 10, 10
mesh_max: 141,167 mesh_max: 141, 167
probe_count: 4,4 probe_count: 4, 4
[filament_switch_sensor filament_sensor] [filament_switch_sensor filament_sensor]
switch_pin: ^PB4 switch_pin: ^PB4

View File

@ -124,7 +124,7 @@ gcode:
# Mesh Bed Leveling. # Mesh Bed Leveling.
[bed_mesh] [bed_mesh]
mesh_min: 5,18 mesh_min: 5, 18
mesh_max: 230,228 mesh_max: 230, 228
probe_count: 9,9 probe_count: 9, 9
algorithm: bicubic algorithm: bicubic

View File

@ -118,26 +118,26 @@ switch_pin: !PA15
pin: PB0 pin: PB0
[safe_z_home] [safe_z_home]
home_xy_position: 165,165 home_xy_position: 165, 165
speed: 50 speed: 50
z_hop: 10 z_hop: 10
z_hop_speed: 5 z_hop_speed: 5
[bed_screws] [bed_screws]
screw1: 5,5 screw1: 5, 5
screw2: 165,5 screw2: 165, 5
screw3: 325,5 screw3: 325, 5
screw4: 5,325 screw4: 5, 325
screw5: 165,325 screw5: 165, 325
screw6: 325,325 screw6: 325, 325
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
probe_count: 5,5 probe_count: 5, 5
horizontal_move_z: 5 horizontal_move_z: 5
algorithm: lagrange algorithm: lagrange
mesh_min : 20,20 mesh_min : 20, 20
mesh_max : 310,310 mesh_max : 310, 310
mesh_pps: 0 mesh_pps: 0
[probe] [probe]

View File

@ -110,26 +110,26 @@ switch_pin: PA15
pin: PB0 pin: PB0
[safe_z_home] [safe_z_home]
home_xy_position: 165,165 home_xy_position: 165, 165
speed: 50 speed: 50
z_hop: 10 z_hop: 10
z_hop_speed: 5 z_hop_speed: 5
[bed_screws] [bed_screws]
screw1: 5,5 screw1: 5, 5
screw2: 165,5 screw2: 165, 5
screw3: 325,5 screw3: 325, 5
screw4: 5,325 screw4: 5, 325
screw5: 165,325 screw5: 165, 325
screw6: 325,325 screw6: 325, 325
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
probe_count: 5,5 probe_count: 5, 5
horizontal_move_z: 5 horizontal_move_z: 5
algorithm: lagrange algorithm: lagrange
mesh_min : 20,20 mesh_min : 20, 20
mesh_max : 310,310 mesh_max : 310, 310
mesh_pps: 0 mesh_pps: 0
[probe] [probe]

View File

@ -92,7 +92,7 @@ z_offset: -15
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_radius:65 mesh_radius:65
mesh_origin: 0,0 mesh_origin: 0, 0
round_probe_count: 7 round_probe_count: 7
algorithm: bicubic algorithm: bicubic

View File

@ -91,18 +91,18 @@ square_corner_velocity: 15.0
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
mesh_min: 27,3 mesh_min: 27, 3
mesh_max: 270,290 mesh_max: 270, 290
probe_count: 5,3 probe_count: 5, 3
horizontal_move_z: 10 horizontal_move_z: 10
[bed_screws] [bed_screws]
screw1: 5,5 screw1: 5, 5
screw1_name: front left screw screw1_name: front left screw
screw2: 295,0 screw2: 295, 0
screw2_name: front right screw screw2_name: front right screw
screw3: 295,290 screw3: 295, 290
screw3_name: back right screw screw3_name: back right screw
screw4: 0,290 screw4: 0, 290
screw4_name: back left screw screw4_name: back left screw
probe_height: 0 probe_height: 0

View File

@ -80,6 +80,6 @@ max_z_velocity: 5
max_z_accel: 100 max_z_accel: 100
[bed_mesh] [bed_mesh]
mesh_min: 20,20 mesh_min: 20, 20
mesh_max: 190,130 mesh_max: 190, 130
probe_count: 4,4 probe_count: 4, 4

View File

@ -21,7 +21,7 @@ position_min: -2 # The Z carriage may need to travel below the Z=0
# The safe_z_home section modifies the default G28 behavior # The safe_z_home section modifies the default G28 behavior
[safe_z_home] [safe_z_home]
home_xy_position: 100,100 home_xy_position: 100, 100
speed: 50 speed: 50
z_hop: 15 z_hop: 15
z_hop_speed: 5 z_hop_speed: 5
@ -29,18 +29,18 @@ z_hop_speed: 5
# Example bed_tilt config section # Example bed_tilt config section
[bed_tilt] [bed_tilt]
points: points:
100,100 100, 100
10,10 10, 10
10,100 10, 100
10,190 10, 190
100,10 100, 10
100,190 100, 190
190,10 190, 10
190,100 190, 100
190,190 190, 190
# Example bed_mesh config section # Example bed_mesh config section
[bed_mesh] [bed_mesh]
mesh_min: 20,20 mesh_min: 20, 20
mesh_max: 200,200 mesh_max: 200, 200
probe_count: 4,4 probe_count: 4, 4

View File

@ -28,7 +28,7 @@ move to the center of the bed, and home the z axis. For example:
``` ```
[safe_z_home] [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 speed: 50
z_hop: 10 # Move up 10mm z_hop: 10 # Move up 10mm
z_hop_speed: 5 z_hop_speed: 5

View File

@ -24,9 +24,9 @@ bed and a probe with an x-offset of 24 mm and y-offset of 5 mm.
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 35,6 mesh_min: 35, 6
mesh_max: 240, 198 mesh_max: 240, 198
probe_count: 5,3 probe_count: 5, 3
``` ```
- `speed: 120`\ - `speed: 120`\
@ -37,21 +37,21 @@ probe_count: 5,3
_Default Value: 5_\ _Default Value: 5_\
The Z coordinate the probe rises to prior to traveling between points. The Z coordinate the probe rises to prior to traveling between points.
- `mesh_min: 35,6`\ - `mesh_min: 35, 6`\
_Required_\ _Required_\
The first probed coordinate, nearest to the origin. This coordinate The first probed coordinate, nearest to the origin. This coordinate
is relative to the probe's location. is relative to the probe's location.
- `mesh_max: 240,198`\ - `mesh_max: 240, 198`\
_Required_\ _Required_\
The probed coordinate farthest farthest from the origin. This is not The probed coordinate farthest farthest from the origin. This is not
necessarily the last point probed, as the probing process occurs in a necessarily the last point probed, as the probing process occurs in a
zig-zag fashion. As with `mesh_min`, this coordiante is relative to zig-zag fashion. As with `mesh_min`, this coordiante is relative to
the probe's location. the probe's location.
- `probe_count: 5,3`\ - `probe_count: 5, 3`\
_Default Value: 3,3_\ _Default Value: 3, 3_\
The number of points to probe on each axis, specified as x,y integer 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 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 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 if you wanted a square grid, for example 3x3, this could be specified
@ -76,7 +76,7 @@ and 5 mm on Y.
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_radius: 75 mesh_radius: 75
mesh_origin: 0,0 mesh_origin: 0, 0
round_probe_count: 5 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, 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. a radius larger than 76 would move the tool beyond the range of the printer.
- `mesh_origin: 0,0`\ - `mesh_origin: 0, 0`\
_Default Value: 0,0_\ _Default Value: 0, 0_\
The center point of the mesh. This coordinate is relative to the probe's 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 in an effort to probe a larger portion of the bed. See the illustration
below. below.
@ -125,20 +125,20 @@ lagrange and bicubic interpolation to accomplish this.
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 35,6 mesh_min: 35, 6
mesh_max: 240, 198 mesh_max: 240, 198
probe_count: 5,3 probe_count: 5, 3
mesh_pps: 2,3 mesh_pps: 2, 3
algorithm: bicubic algorithm: bicubic
bicubic_tension: 0.2 bicubic_tension: 0.2
``` ```
- `mesh_pps: 2,3`\ - `mesh_pps: 2, 3`\
_Default Value: 2,2_\ _Default Value: 2, 2_\
The `mesh_pps` option is shorthand for Mesh Points Per Segment. This The `mesh_pps` option is shorthand for Mesh Points Per Segment. This
option specifies how many points to interpolate for each segment along 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 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 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 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 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 and 2 segments along the Y axis. This evaluates to 8 interpolated
@ -179,9 +179,9 @@ control the splitting behavior.
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 35,6 mesh_min: 35, 6
mesh_max: 240, 198 mesh_max: 240, 198
probe_count: 5,3 probe_count: 5, 3
move_check_distance: 5 move_check_distance: 5
split_delta_z: .025 split_delta_z: .025
``` ```
@ -225,9 +225,9 @@ As such, fade is disabled by default.
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 35,6 mesh_min: 35, 6
mesh_max: 240, 198 mesh_max: 240, 198
probe_count: 5,3 probe_count: 5, 3
fade_start: 1 fade_start: 1
fade_end: 10 fade_end: 10
fade_target: 0 fade_target: 0
@ -273,9 +273,9 @@ These printers can benefit from configuring the relative reference index.
[bed_mesh] [bed_mesh]
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 35,6 mesh_min: 35, 6
mesh_max: 240, 198 mesh_max: 240, 198
probe_count: 5,3 probe_count: 5, 3
relative_reference_index: 7 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] [bed_mesh]
speed: 120 speed: 120
horizontal_move_z: 5 horizontal_move_z: 5
mesh_min: 35,6 mesh_min: 35, 6
mesh_max: 240, 198 mesh_max: 240, 198
probe_count: 5,3 probe_count: 5, 3
faulty_region_1_min: 130.0, 0.0 faulty_region_1_min: 130.0, 0.0
faulty_region_1_max: 145.0, 40.0 faulty_region_1_max: 145.0, 40.0
faulty_region_2_min: 225.0, 0.0 faulty_region_2_min: 225.0, 0.0

View File

@ -95,7 +95,7 @@ gcode:
G90 G90
G0 Z15 F300 G0 Z15 F300
{% for wipe in range(wipe_count) %} {% 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 G0 X{coordinate[0]} Y{coordinate[1] + 0.25 * wipe} Z9.7 F12000
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}

View File

@ -462,7 +462,7 @@ Only parameters specific to polar printers are described here - see
[common kinematic settings](#common-kinematic-settings) for available [common kinematic settings](#common-kinematic-settings) for available
parameters. 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. 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 SUPPORT IS EXPERIMENTAL. Homing is not implemented on
cable winch kinematics. In order to home the printer, manually send 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. `G28` command.
``` ```
@ -615,7 +615,7 @@ rotation_distance:
anchor_x: anchor_x:
anchor_y: anchor_y:
anchor_z: 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. # These parameters must be provided.
``` ```
@ -793,7 +793,7 @@ information.
Visual Examples: Visual Examples:
``` ```
rectangular bed, probe_count = 3,3: rectangular bed, probe_count = 3, 3:
x---x---x (max_point) x---x---x (max_point)
| |
x---x---x x---x---x
@ -801,15 +801,15 @@ Visual Examples:
(min_point) x---x---x (min_point) x---x---x
round bed, round_probe_count = 5, bed_radius = r: round bed, round_probe_count = 5, bed_radius = r:
x (0,r) end x (0, r) end
/ /
x---x---x x---x---x
\ \
(-r,0) x---x---x---x---x (r,0) (-r, 0) x---x---x---x---x (r, 0)
\ \
x---x---x x---x---x
/ /
x (0,-r) start x (0, -r) start
``` ```
``` ```
@ -826,26 +826,26 @@ Visual Examples:
# mesh_origin option. This parameter must be provided for round beds # mesh_origin option. This parameter must be provided for round beds
# and omitted for rectangular beds. # and omitted for rectangular beds.
#mesh_origin: #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 # 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 # 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. # rectangular beds.
#mesh_min: #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 # beds. This coordinate is relative to the probe's location. This
# will be the first point probed, nearest to the origin. This # will be the first point probed, nearest to the origin. This
# parameter must be provided for rectangular beds. # parameter must be provided for rectangular beds.
#mesh_max: #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 # beds. Adheres to the same principle as mesh_min, however this will
# be the furthest point probed from the bed's origin. This parameter # be the furthest point probed from the bed's origin. This parameter
# must be provided for rectangular beds. # 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 # 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 # 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 #round_probe_count: 5
# For round beds, this integer value defines the maximum number of # For round beds, this integer value defines the maximum number of
# points to probe along each axis. This value must be an odd number. # 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. # 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 # This is also the minimum length that a move can be split. Default
# is 5.0. # is 5.0.
#mesh_pps: 2,2 #mesh_pps: 2, 2
# A comma separated pair of integers (X,Y) defining the number of # A comma separated pair of integers X, Y defining the number of
# points per segment to interpolate in the mesh along each axis. A # points per segment to interpolate in the mesh along each axis. A
# "segment" can be defined as the space between each probed point. # "segment" can be defined as the space between each probed point.
# The user may enter a single value which will be applied to both # 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 #algorithm: lagrange
# The interpolation algorithm to use. May be either "lagrange" or # The interpolation algorithm to use. May be either "lagrange" or
# "bicubic". This option will not affect 3x3 grids, which are forced # "bicubic". This option will not affect 3x3 grids, which are forced
@ -916,12 +916,12 @@ information.
# axis. The default is 0. # axis. The default is 0.
#z_adjust: 0 #z_adjust: 0
# The amount to add to the Z height when the nozzle is nominally at # 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 # The remaining parameters control a BED_TILT_CALIBRATE extended
# g-code command that may be used to calibrate appropriate x and y # g-code command that may be used to calibrate appropriate x and y
# adjustment parameters. # adjustment parameters.
#points: #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 # indented) that should be probed during a BED_TILT_CALIBRATE
# command. Specify coordinates of the nozzle and be sure the probe # command. Specify coordinates of the nozzle and be sure the probe
# is above the bed at the given nozzle coordinates. The default is # is above the bed at the given nozzle coordinates. The default is
@ -947,7 +947,7 @@ information.
``` ```
[bed_screws] [bed_screws]
#screw1: #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 # position to command the nozzle to that is directly above the bed
# screw (or as close as possible while still being above the bed). # screw (or as close as possible while still being above the bed).
# This parameter must be provided. # This parameter must be provided.
@ -956,7 +956,7 @@ information.
# the helper script runs. The default is to use a name based upon # the helper script runs. The default is to use a name based upon
# the screw XY location. # the screw XY location.
#screw1_fine_adjust: #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 # tune the bed leveling screw. The default is to not perform fine
# adjustments on the bed screw. # adjustments on the bed screw.
#screw2: #screw2:
@ -993,7 +993,7 @@ additional information.
``` ```
[screws_tilt_adjust] [screws_tilt_adjust]
#screw1: #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 # position to command the nozzle to that is directly above the bed
# screw (or as close as possible while still being 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 # 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_tilt]
#z_positions: #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 # indented) describing the location of each bed "pivot point". The
# "pivot point" is the point where the bed attaches to the given Z # "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 # of the nozzle if it could move directly above the point). The
# first entry corresponds to stepper_z, the second to stepper_z1, # first entry corresponds to stepper_z, the second to stepper_z1,
# the third to stepper_z2, etc. This parameter must be provided. # the third to stepper_z2, etc. This parameter must be provided.
#points: #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. # indented) that should be probed during a Z_TILT_ADJUST command.
# Specify coordinates of the nozzle and be sure the probe is above # Specify coordinates of the nozzle and be sure the probe is above
# the bed at the given nozzle coordinates. This parameter must be # the bed at the given nozzle coordinates. This parameter must be
@ -1082,16 +1082,16 @@ configuration:
|Z Z3| |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] [quad_gantry_level]
#gantry_corners: #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, # opposing corners of the gantry. The first entry corresponds to Z,
# the second to Z2. This parameter must be provided. # the second to Z2. This parameter must be provided.
#points: #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 # during a QUAD_GANTRY_LEVEL command. Order of the locations is
# important, and should correspond to Z, Z1, Z2, and Z3 location in # important, and should correspond to Z, Z1, Z2, and Z3 location in
# order. This parameter must be provided. For maximum accuracy, # 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_home]
Safe Z homing. One may use this mechanism to home the Z axis at a 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. has to move to the center of the bed before Z can be homed.
``` ```
[safe_z_home] [safe_z_home]
home_xy_position: 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. # performed. This parameter must be provided.
#speed: 50.0 #speed: 50.0
# Speed at which the toolhead is moved to the safe Z home # 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 # Speed (in mm/s) at which the Z axis is lifted prior to homing. The
# default is 20mm/s. # default is 20mm/s.
#move_to_previous: False #move_to_previous: False
# When set to True, xy are reset to their previous positions after z # When set to True, the X and Y axes are reset to their previous
# homing. The default is False. # positions after Z axis homing. The default is False.
``` ```
### [homing_override] ### [homing_override]
@ -1489,13 +1489,13 @@ cs_pin:
#spi_software_miso_pin: #spi_software_miso_pin:
# See the "common SPI settings" section for a description of the # See the "common SPI settings" section for a description of the
# above parameters. # above parameters.
#axes_map: x,y,z #axes_map: x, y, z
# The accelerometer axis for each of the printer's x, y, and z axes. # 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 # This may be useful if the accelerometer is mounted in an
# orientation that does not match the printer orientation. For # 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 # 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 #rate: 3200
# Output data rate for ADXL345. ADXL345 supports the following data # Output data rate for ADXL345. ADXL345 supports the following data
# rates: 3200, 1600, 800, 400, 200, 100, 50, and 25. Note that it is # 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] [resonance_tester]
#probe_points: #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 # resonances at. At least one point is required. Make sure that all
# points with some safety margin in XY plane (~a few centimeters) # points with some safety margin in XY plane (~a few centimeters)
# are reachable by the toolhead. # are reachable by the toolhead.
@ -3891,7 +3891,7 @@ example.
``` ```
# The "replicape" config section adds "replicape:stepper_x_enable" # 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, # "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. # fan2, and fan3) that may then be used elsewhere in the config file.
[replicape] [replicape]

View File

@ -445,7 +445,7 @@ The following commands are available when the
available while this tool is active. available while this tool is active.
- `BED_MESH_OUTPUT PGP=[<0:1>]`: This command outputs the current probed - `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 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. indices, will be output to the terminal.
- `BED_MESH_MAP`: Like to BED_MESH_OUTPUT, this command prints the current - `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 state of the mesh to the terminal. Instead of printing the values in a

View File

@ -63,9 +63,9 @@ This is done by creating a `[bed_screws]` config section. For example,
it might look something similar to: it might look something similar to:
``` ```
[bed_screws] [bed_screws]
screw1: 100,50 screw1: 100, 50
screw2: 100,150 screw2: 100, 150
screw3: 150,100 screw3: 150, 100
``` ```
If a bed screw is under the bed, then specify the XY position directly 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 BED_SCREWS_ADJUST
``` ```
This tool will move the printer's nozzle to each screw XY location and This tool will move the printer's nozzle to each screw XY location
then move the nozzle to a Z=0 height. At this point one can use the 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 "paper test" to adjust the bed screw directly under the nozzle. See
the information described in the information described in
["the paper test"](Bed_Level.md#the-paper-test), but adjust the bed ["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: look like:
``` ```
[bed_screws] [bed_screws]
screw1: 100,50 screw1: 100, 50
screw1_fine_adjust: 0,0 screw1_fine_adjust: 0, 0
screw2: 100,150 screw2: 100, 150
screw2_fine_adjust: 300,300 screw2_fine_adjust: 300, 300
screw3: 150,100 screw3: 150, 100
screw3_fine_adjust: 0,100 screw3_fine_adjust: 0, 100
``` ```
When this feature is enabled, the `BED_SCREWS_ADJUST` tool will first 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] [screws_tilt_adjust]
screw1: -5,30 screw1: -5, 30
screw1_name: front left screw screw1_name: front left screw
screw2: 155,30 screw2: 155, 30
screw2_name: front right screw screw2_name: front right screw
screw3: 155,190 screw3: 155, 190
screw3_name: rear right screw screw3_name: rear right screw
screw4: -5,190 screw4: -5, 190
screw4_name: rear left screw screw4_name: rear left screw
horizontal_move_z: 10. horizontal_move_z: 10.
speed: 50. speed: 50.

View File

@ -98,7 +98,7 @@ cs_pin: rpi:None
[resonance_tester] [resonance_tester]
accel_chip: adxl345 accel_chip: adxl345
probe_points: 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, It is advised to start with 1 probe point, in the middle of the print bed,
slightly above it. slightly above it.

View File

@ -1,6 +1,6 @@
# Probe calibration # 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 offsets of an "automatic z probe" in Klipper. This is useful for users
that have a `[probe]` or `[bltouch]` section in their config file. that have a `[probe]` or `[bltouch]` section in their config file.

View File

@ -36,7 +36,7 @@ Most drivers use 16 microsteps. If unsure, set `microsteps: 16` in the
config and use 16 in the formula above. config and use 16 in the formula above.
Almost all printers should have a whole number for `rotation_distance` 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 rotation_distance that is within .01 of a whole number then round the
final value to that whole_number. final value to that whole_number.