From de366ee85479d9f9bf7f117a881feb8de522265d Mon Sep 17 00:00:00 2001 From: Paul McGowan Date: Sun, 9 Jan 2022 21:13:53 -0500 Subject: [PATCH] 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 --- config/example-polar.cfg | 2 +- config/example-winch.cfg | 2 +- config/kit-voron2-250mm.cfg | 10 +-- config/kit-zav3d-2019.cfg | 6 +- config/printer-anycubic-4maxpro-2.0-2021.cfg | 8 +- config/printer-creality-cr20-pro-2019.cfg | 8 +- config/printer-creality-ender5plus-2019.cfg | 4 +- config/printer-creality-ender6-2020.cfg | 2 +- config/printer-creality-sermoonD1-2021.cfg | 2 +- config/printer-eryone-er20-2021.cfg | 8 +- config/printer-fokoos-odin5-f3-2021.cfg | 12 +-- config/printer-hiprecy-leo-2019.cfg | 6 +- config/printer-longer-lk4-pro-2019.cfg | 6 +- config/printer-lulzbot-mini1-2016.cfg | 8 +- config/printer-lulzbot-taz6-2017.cfg | 10 +-- config/printer-lulzbot-taz6-dual-v3-2017.cfg | 10 +-- .../printer-monoprice-select-mini-v2-2018.cfg | 8 +- config/printer-mtw-create-2015.cfg | 6 +- config/printer-prusa-mini-plus-2020.cfg | 8 +- config/printer-tevo-flash-2018.cfg | 6 +- config/printer-tronxy-x5sa-pro-2020.cfg | 20 ++--- config/printer-tronxy-x5sa-v6-2019.cfg | 20 ++--- config/printer-velleman-k8800-2017.cfg | 2 +- config/printer-wanhao-duplicator-9-2018.cfg | 14 +-- ...r-wanhao-duplicator-i3-plus-mark2-2019.cfg | 6 +- config/sample-probe-as-z-endstop.cfg | 26 +++--- docs/BLTouch.md | 2 +- docs/Bed_Mesh.md | 52 +++++------ docs/Command_Templates.md | 2 +- docs/Config_Reference.md | 88 +++++++++---------- docs/G-Codes.md | 2 +- docs/Manual_Level.md | 30 +++---- docs/Measuring_Resonances.md | 2 +- docs/Probe_Calibrate.md | 2 +- docs/Rotation_Distance.md | 2 +- 35 files changed, 201 insertions(+), 201 deletions(-) diff --git a/config/example-polar.cfg b/config/example-polar.cfg index 62055038..90840fa1 100644 --- a/config/example-polar.cfg +++ b/config/example-polar.cfg @@ -1,7 +1,7 @@ # 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 +# POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the 0, 0 # position are known to not work properly. # See docs/Config_Reference.md for a description of parameters. diff --git a/config/example-winch.cfg b/config/example-winch.cfg index 5813aef7..d6d62b8a 100644 --- a/config/example-winch.cfg +++ b/config/example-winch.cfg @@ -6,7 +6,7 @@ # 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 G28 command. +# is at 0, 0, 0 and then issue a G28 command. # See docs/Config_Reference.md for a description of parameters. diff --git a/config/kit-voron2-250mm.cfg b/config/kit-voron2-250mm.cfg index 282e7595..343e9c67 100644 --- a/config/kit-voron2-250mm.cfg +++ b/config/kit-voron2-250mm.cfg @@ -227,14 +227,14 @@ gcode: [quad_gantry_level] # Use QUAD_GANTRY_LEVEL to level a gantry. gantry_corners: - -55,-7 + -55, -7 305, 320 # Min & Max gantry corners - measure from nozzle at MIN (0,0) and MAX (250,250) to respective belt positions points: - 25,0 - 25,200 - 225,200 - 225,0 + 25, 0 + 25, 200 + 225, 200 + 225, 0 # Probe points speed: 200 horizontal_move_z: 6 diff --git a/config/kit-zav3d-2019.cfg b/config/kit-zav3d-2019.cfg index b27e6017..e3b57b8e 100644 --- a/config/kit-zav3d-2019.cfg +++ b/config/kit-zav3d-2019.cfg @@ -134,9 +134,9 @@ sample_retract_dist: 3.0 [bed_mesh] speed: 100 horizontal_move_z: 5 -mesh_min: 69,41 -mesh_max: 189,161 -probe_count: 3,3 +mesh_min: 69, 41 +mesh_max: 189, 161 +probe_count: 3, 3 [homing_override] set_position_z: 6 diff --git a/config/printer-anycubic-4maxpro-2.0-2021.cfg b/config/printer-anycubic-4maxpro-2.0-2021.cfg index f87fce49..75d32411 100644 --- a/config/printer-anycubic-4maxpro-2.0-2021.cfg +++ b/config/printer-anycubic-4maxpro-2.0-2021.cfg @@ -132,10 +132,10 @@ max_z_accel: 50 square_corner_velocity: 5 [bed_screws] -screw1: 5,5 -screw2: 265,210 -screw3: 5,210 -screw4: 265,5 +screw1: 5, 5 +screw2: 265, 210 +screw3: 5, 210 +screw4: 265, 5 [filament_switch_sensor filament_sensor] switch_pin: ^!PC4 diff --git a/config/printer-creality-cr20-pro-2019.cfg b/config/printer-creality-cr20-pro-2019.cfg index 19b46b63..29f04fe6 100644 --- a/config/printer-creality-cr20-pro-2019.cfg +++ b/config/printer-creality-cr20-pro-2019.cfg @@ -64,7 +64,7 @@ speed: 3.0 samples: 1 [safe_z_home] -home_xy_position: 117,117 +home_xy_position: 117, 117 speed: 50.0 z_hop: 10.0 z_hop_speed: 100 @@ -72,9 +72,9 @@ z_hop_speed: 100 [bed_mesh] speed: 100 horizontal_move_z: 8 -mesh_min: 106,39 -mesh_max: 281,229 -probe_count: 3,3 +mesh_min: 106, 39 +mesh_max: 281, 229 +probe_count: 3, 3 [heater_bed] heater_pin: PH5 diff --git a/config/printer-creality-ender5plus-2019.cfg b/config/printer-creality-ender5plus-2019.cfg index f8e2d1be..2dd0ef2c 100644 --- a/config/printer-creality-ender5plus-2019.cfg +++ b/config/printer-creality-ender5plus-2019.cfg @@ -75,8 +75,8 @@ pin_up_touch_mode_reports_triggered: False speed: 100 horizontal_move_z: 8 mesh_min: 50, 50 -mesh_max: 300,300 -probe_count: 3,3 +mesh_max: 300, 300 +probe_count: 3, 3 [heater_bed] heater_pin: PH5 diff --git a/config/printer-creality-ender6-2020.cfg b/config/printer-creality-ender6-2020.cfg index a5791a84..b4048cb7 100644 --- a/config/printer-creality-ender6-2020.cfg +++ b/config/printer-creality-ender6-2020.cfg @@ -75,7 +75,7 @@ position_max: 400 # mesh_min: 10, 10 # mesh_max: 239, 239 # algorithm: bicubic -# probe_count: 5,5 +# probe_count: 5, 5 [extruder] max_extrude_only_distance: 1000.0 diff --git a/config/printer-creality-sermoonD1-2021.cfg b/config/printer-creality-sermoonD1-2021.cfg index 08849814..b06abcf0 100644 --- a/config/printer-creality-sermoonD1-2021.cfg +++ b/config/printer-creality-sermoonD1-2021.cfg @@ -113,7 +113,7 @@ restart_method: command # mesh_min: 20, 15 # mesh_max: 250, 240 # algorithm: bicubic -# probe_count: 5,5 +# probe_count: 5, 5 [filament_switch_sensor filament_sensor] pause_on_runout: true diff --git a/config/printer-eryone-er20-2021.cfg b/config/printer-eryone-er20-2021.cfg index 6acd4dd0..9fc25f52 100644 --- a/config/printer-eryone-er20-2021.cfg +++ b/config/printer-eryone-er20-2021.cfg @@ -141,15 +141,15 @@ z_offset: 2.6 pin_up_touch_mode_reports_triggered: False [safe_z_home] -home_xy_position: 5,5 +home_xy_position: 5, 5 z_hop: 5.0 z_hop_speed: 5.0 [bed_mesh] speed: 80 -mesh_min: 40,20 -mesh_max: 210,205 -probe_count: 5,5 +mesh_min: 40, 20 +mesh_max: 210, 205 +probe_count: 5, 5 ###################################################################### # "RepRapDiscount 128x64 Full Graphic Smart Controller" type display diff --git a/config/printer-fokoos-odin5-f3-2021.cfg b/config/printer-fokoos-odin5-f3-2021.cfg index cdab9c41..fc75d927 100644 --- a/config/printer-fokoos-odin5-f3-2021.cfg +++ b/config/printer-fokoos-odin5-f3-2021.cfg @@ -42,10 +42,10 @@ max_z_velocity: 25 max_z_accel: 100 [bed_screws] -screw1: 33,33 -screw2: 203,33 -screw3: 203,201 -screw4: 33,201 +screw1: 33, 33 +screw2: 203, 33 +screw3: 203, 201 +screw4: 33, 201 [stepper_x] step_pin: PE3 @@ -158,7 +158,7 @@ switch_pin: !PA4 # Optional bed mesh configuration you can use if you have a BLtouch installed. #[bed_mesh] -#mesh_min: 70,15 -#mesh_max: 220,210 +#mesh_min: 70, 15 +#mesh_max: 220, 210 #horizontal_move_z: 5 #speed: 150 diff --git a/config/printer-hiprecy-leo-2019.cfg b/config/printer-hiprecy-leo-2019.cfg index a2a098cc..5651916a 100644 --- a/config/printer-hiprecy-leo-2019.cfg +++ b/config/printer-hiprecy-leo-2019.cfg @@ -93,9 +93,9 @@ speed: 5 ######################################## [bed_mesh] -mesh_min: 40,40 -mesh_max: 185,230 -probe_count: 4,4 +mesh_min: 40, 40 +mesh_max: 185, 230 +probe_count: 4, 4 speed: 100 fade_end: 0.0 algorithm: bicubic diff --git a/config/printer-longer-lk4-pro-2019.cfg b/config/printer-longer-lk4-pro-2019.cfg index 412ece2f..2ef49cfb 100644 --- a/config/printer-longer-lk4-pro-2019.cfg +++ b/config/printer-longer-lk4-pro-2019.cfg @@ -65,9 +65,9 @@ position_max: 250 # z_offset: 1.56 # [bed_mesh] -# mesh_min: 16,16 -# mesh_max: 201,200 -# probe_count: 4,3 +# mesh_min: 16, 16 +# mesh_max: 201, 200 +# probe_count: 4, 3 [extruder] step_pin: PA4 diff --git a/config/printer-lulzbot-mini1-2016.cfg b/config/printer-lulzbot-mini1-2016.cfg index 0e8e7816..b1471dd1 100644 --- a/config/printer-lulzbot-mini1-2016.cfg +++ b/config/printer-lulzbot-mini1-2016.cfg @@ -197,10 +197,10 @@ samples_tolerance_retries: 2 [bed_tilt] # Enable bed tilt measurments using the probe we defined above # Probe points using X0 Y0 offsets @ 0.01mm/step -points: -2,-6 - 156,-6 - 156,158 - -2,158 +points: -2, -6 + 156, -6 + 156, 158 + -2, 158 speed: 75 horizontal_move_z: 2 diff --git a/config/printer-lulzbot-taz6-2017.cfg b/config/printer-lulzbot-taz6-2017.cfg index 93c2bd14..8046381f 100644 --- a/config/printer-lulzbot-taz6-2017.cfg +++ b/config/printer-lulzbot-taz6-2017.cfg @@ -151,15 +151,15 @@ sample_retract_dist: 1.0 samples_tolerance: 0.075 [bed_tilt] -points: -9,-9 - 289.4,-9 - 289.4,290 - -9,289 +points: -9, -9 + 289.4, -9 + 289.4, 290 + -9, 289 speed: 75 horizontal_move_z: 5 [safe_z_home] -home_xy_position: -19.1,259.3 +home_xy_position: -19.1, 259.3 speed: 50.0 z_hop: 10.0 diff --git a/config/printer-lulzbot-taz6-dual-v3-2017.cfg b/config/printer-lulzbot-taz6-dual-v3-2017.cfg index e7a43653..2ec91f9e 100644 --- a/config/printer-lulzbot-taz6-dual-v3-2017.cfg +++ b/config/printer-lulzbot-taz6-dual-v3-2017.cfg @@ -185,10 +185,10 @@ samples_tolerance: 0.100 [bed_tilt] #Enable bed tilt measurments using the probe we defined above #Probe points using X0 Y0 offsets @ 0.01mm/step -points: -3,-6 - 282,-6 - 282,300 - -3,300 +points: -3, -6 + 282, -6 + 282, 300 + -3, 300 speed: 75 horizontal_move_z: 5 @@ -196,7 +196,7 @@ horizontal_move_z: 5 #Needed to lift the Z to clear homing switch on bed # ---> WARNING! - Z_MAX limit switch not monitored in Klipper! <--- # ---> 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 z_hop: 15.0 move_to_previous: False diff --git a/config/printer-monoprice-select-mini-v2-2018.cfg b/config/printer-monoprice-select-mini-v2-2018.cfg index 3bc86c75..289a931d 100644 --- a/config/printer-monoprice-select-mini-v2-2018.cfg +++ b/config/printer-monoprice-select-mini-v2-2018.cfg @@ -143,10 +143,10 @@ max_z_accel: 20 # Positions for BED_SCREWS_ADJUST levelling with bed screws still accessible [bed_screws] -screw1: 22,10 -screw2: 22,90 -screw3: 98,90 -screw4: 98,10 +screw1: 22, 10 +screw2: 22, 90 +screw3: 98, 90 +screw4: 98, 10 ###################################################################### # Optional: i2c ssd1306 OLED-display controlled by raspi host_mcu diff --git a/config/printer-mtw-create-2015.cfg b/config/printer-mtw-create-2015.cfg index 4194fd23..674d0be9 100644 --- a/config/printer-mtw-create-2015.cfg +++ b/config/printer-mtw-create-2015.cfg @@ -93,13 +93,13 @@ y_offset: 37 z_offset: 2.0 [safe_z_home] -home_xy_position: 125,150 +home_xy_position: 125, 150 z_hop: 10 z_hop_speed: 5 [bed_mesh] -mesh_min: 5,5 -mesh_max: 225,225 +mesh_min: 5, 5 +mesh_max: 225, 225 [fan] pin: PH5 diff --git a/config/printer-prusa-mini-plus-2020.cfg b/config/printer-prusa-mini-plus-2020.cfg index 2893738f..e64a27ba 100644 --- a/config/printer-prusa-mini-plus-2020.cfg +++ b/config/printer-prusa-mini-plus-2020.cfg @@ -158,15 +158,15 @@ z_offset: 0 # set this to your Live Z Offset, but negated (invert the sign) speed: 6.0 [safe_z_home] -home_xy_position: 147.4,21.1 +home_xy_position: 147.4, 21.1 z_hop: 4 [bed_mesh] speed: 100 horizontal_move_z: 5 -mesh_min: 10,10 -mesh_max: 141,167 -probe_count: 4,4 +mesh_min: 10, 10 +mesh_max: 141, 167 +probe_count: 4, 4 [filament_switch_sensor filament_sensor] switch_pin: ^PB4 diff --git a/config/printer-tevo-flash-2018.cfg b/config/printer-tevo-flash-2018.cfg index 210419ae..e6dee68f 100644 --- a/config/printer-tevo-flash-2018.cfg +++ b/config/printer-tevo-flash-2018.cfg @@ -124,7 +124,7 @@ gcode: # Mesh Bed Leveling. [bed_mesh] -mesh_min: 5,18 -mesh_max: 230,228 -probe_count: 9,9 +mesh_min: 5, 18 +mesh_max: 230, 228 +probe_count: 9, 9 algorithm: bicubic diff --git a/config/printer-tronxy-x5sa-pro-2020.cfg b/config/printer-tronxy-x5sa-pro-2020.cfg index b09fffc1..50bf2d1b 100644 --- a/config/printer-tronxy-x5sa-pro-2020.cfg +++ b/config/printer-tronxy-x5sa-pro-2020.cfg @@ -118,26 +118,26 @@ switch_pin: !PA15 pin: PB0 [safe_z_home] -home_xy_position: 165,165 +home_xy_position: 165, 165 speed: 50 z_hop: 10 z_hop_speed: 5 [bed_screws] -screw1: 5,5 -screw2: 165,5 -screw3: 325,5 -screw4: 5,325 -screw5: 165,325 -screw6: 325,325 +screw1: 5, 5 +screw2: 165, 5 +screw3: 325, 5 +screw4: 5, 325 +screw5: 165, 325 +screw6: 325, 325 [bed_mesh] speed: 120 -probe_count: 5,5 +probe_count: 5, 5 horizontal_move_z: 5 algorithm: lagrange -mesh_min : 20,20 -mesh_max : 310,310 +mesh_min : 20, 20 +mesh_max : 310, 310 mesh_pps: 0 [probe] diff --git a/config/printer-tronxy-x5sa-v6-2019.cfg b/config/printer-tronxy-x5sa-v6-2019.cfg index 069f60d6..e61dacc3 100644 --- a/config/printer-tronxy-x5sa-v6-2019.cfg +++ b/config/printer-tronxy-x5sa-v6-2019.cfg @@ -110,26 +110,26 @@ switch_pin: PA15 pin: PB0 [safe_z_home] -home_xy_position: 165,165 +home_xy_position: 165, 165 speed: 50 z_hop: 10 z_hop_speed: 5 [bed_screws] -screw1: 5,5 -screw2: 165,5 -screw3: 325,5 -screw4: 5,325 -screw5: 165,325 -screw6: 325,325 +screw1: 5, 5 +screw2: 165, 5 +screw3: 325, 5 +screw4: 5, 325 +screw5: 165, 325 +screw6: 325, 325 [bed_mesh] speed: 120 -probe_count: 5,5 +probe_count: 5, 5 horizontal_move_z: 5 algorithm: lagrange -mesh_min : 20,20 -mesh_max : 310,310 +mesh_min : 20, 20 +mesh_max : 310, 310 mesh_pps: 0 [probe] diff --git a/config/printer-velleman-k8800-2017.cfg b/config/printer-velleman-k8800-2017.cfg index c1a8abe6..97e96112 100644 --- a/config/printer-velleman-k8800-2017.cfg +++ b/config/printer-velleman-k8800-2017.cfg @@ -92,7 +92,7 @@ z_offset: -15 speed: 120 horizontal_move_z: 5 mesh_radius:65 -mesh_origin: 0,0 +mesh_origin: 0, 0 round_probe_count: 7 algorithm: bicubic diff --git a/config/printer-wanhao-duplicator-9-2018.cfg b/config/printer-wanhao-duplicator-9-2018.cfg index e3f5beeb..958a2d5f 100644 --- a/config/printer-wanhao-duplicator-9-2018.cfg +++ b/config/printer-wanhao-duplicator-9-2018.cfg @@ -91,18 +91,18 @@ square_corner_velocity: 15.0 [bed_mesh] speed: 120 -mesh_min: 27,3 -mesh_max: 270,290 -probe_count: 5,3 +mesh_min: 27, 3 +mesh_max: 270, 290 +probe_count: 5, 3 horizontal_move_z: 10 [bed_screws] -screw1: 5,5 +screw1: 5, 5 screw1_name: front left screw -screw2: 295,0 +screw2: 295, 0 screw2_name: front right screw -screw3: 295,290 +screw3: 295, 290 screw3_name: back right screw -screw4: 0,290 +screw4: 0, 290 screw4_name: back left screw probe_height: 0 diff --git a/config/printer-wanhao-duplicator-i3-plus-mark2-2019.cfg b/config/printer-wanhao-duplicator-i3-plus-mark2-2019.cfg index 5a499bc2..33b808b4 100644 --- a/config/printer-wanhao-duplicator-i3-plus-mark2-2019.cfg +++ b/config/printer-wanhao-duplicator-i3-plus-mark2-2019.cfg @@ -80,6 +80,6 @@ max_z_velocity: 5 max_z_accel: 100 [bed_mesh] -mesh_min: 20,20 -mesh_max: 190,130 -probe_count: 4,4 +mesh_min: 20, 20 +mesh_max: 190, 130 +probe_count: 4, 4 diff --git a/config/sample-probe-as-z-endstop.cfg b/config/sample-probe-as-z-endstop.cfg index 5deb088f..f458a5f3 100644 --- a/config/sample-probe-as-z-endstop.cfg +++ b/config/sample-probe-as-z-endstop.cfg @@ -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 [safe_z_home] -home_xy_position: 100,100 +home_xy_position: 100, 100 speed: 50 z_hop: 15 z_hop_speed: 5 @@ -29,18 +29,18 @@ z_hop_speed: 5 # Example bed_tilt config section [bed_tilt] points: - 100,100 - 10,10 - 10,100 - 10,190 - 100,10 - 100,190 - 190,10 - 190,100 - 190,190 + 100, 100 + 10, 10 + 10, 100 + 10, 190 + 100, 10 + 100, 190 + 190, 10 + 190, 100 + 190, 190 # Example bed_mesh config section [bed_mesh] -mesh_min: 20,20 -mesh_max: 200,200 -probe_count: 4,4 +mesh_min: 20, 20 +mesh_max: 200, 200 +probe_count: 4, 4 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.