From 6c018eb7703d9c859a065631553bf2af3ad1aaca Mon Sep 17 00:00:00 2001 From: Andrew <18502096+classicrocker883@users.noreply.github.com> Date: Mon, 20 May 2024 01:01:05 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20some=20G-code=20and=20o?= =?UTF-8?q?ther=20comments=20=20(#27034)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Marlin/src/feature/bedlevel/bdl/bdl.cpp | 14 ++++++++++---- Marlin/src/gcode/bedlevel/G42.cpp | 6 ++++++ Marlin/src/gcode/probe/G38.cpp | 2 +- Marlin/src/gcode/probe/M951.cpp | 15 +++++++++++++++ .../src/lcd/tft/images/time_elapsed_32x32x4.cpp | 3 ++- .../src/lcd/tft/images/time_remaining_32x32x4.cpp | 3 ++- Marlin/src/sd/SdBaseFile.cpp | 2 +- buildroot/share/cmake/CMakeLists.txt | 8 ++++---- 8 files changed, 41 insertions(+), 12 deletions(-) diff --git a/Marlin/src/feature/bedlevel/bdl/bdl.cpp b/Marlin/src/feature/bedlevel/bdl/bdl.cpp index d469bb0c06..7e9d583cc1 100644 --- a/Marlin/src/feature/bedlevel/bdl/bdl.cpp +++ b/Marlin/src/feature/bedlevel/bdl/bdl.cpp @@ -46,10 +46,16 @@ BDS_Leveling bdl; #define DEBUG_OUT ENABLED(DEBUG_OUT_BD) #include "../../../core/debug_out.h" -// M102 S-5 Read raw Calibrate data -// M102 S-6 Start Calibrate -// M102 S4 Set the adjustable Z height value (e.g., 'M102 S4' means it will do adjusting while the Z height <= 0.4mm , disable with 'M102 S0'.) -// M102 S-1 Read sensor information +/** + * M102 S<#> : Set adjustable Z height in 0.1mm units (10ths of a mm) + * (e.g., 'M102 S4' enables adjusting for Z <= 0.4mm) + * M102 S0 : Disable adjustable Z height + * + * M102 S-1 : Read BDsensor version + * M102 S-2 : Read BDsensor distance value + * M102 S-5 : Read raw Calibration data + * M102 S-6 : Start Calibration + */ #define MAX_BD_HEIGHT 4.0f #define CMD_READ_VERSION 1016 diff --git a/Marlin/src/gcode/bedlevel/G42.cpp b/Marlin/src/gcode/bedlevel/G42.cpp index cb5ed97406..193131ee4c 100644 --- a/Marlin/src/gcode/bedlevel/G42.cpp +++ b/Marlin/src/gcode/bedlevel/G42.cpp @@ -32,6 +32,12 @@ /** * G42: Move X & Y axes to mesh coordinates (I & J) + * + * Parameters: + * F : Feedrate in mm/min + * I : X axis point index + * J : Y axis point index + * P : Flag to put the prove at the given point */ void GcodeSuite::G42() { if (MOTION_CONDITIONS) { diff --git a/Marlin/src/gcode/probe/G38.cpp b/Marlin/src/gcode/probe/G38.cpp index 1f22cc84ed..d57eb9b59e 100644 --- a/Marlin/src/gcode/probe/G38.cpp +++ b/Marlin/src/gcode/probe/G38.cpp @@ -55,7 +55,7 @@ inline bool G38_run_probe() { } #endif - planner.synchronize(); // wait until the machine is idle + planner.synchronize(); // Wait until the machine is idle // Move flag value #if ENABLED(G38_PROBE_AWAY) diff --git a/Marlin/src/gcode/probe/M951.cpp b/Marlin/src/gcode/probe/M951.cpp index 93feffdce9..db0278e431 100644 --- a/Marlin/src/gcode/probe/M951.cpp +++ b/Marlin/src/gcode/probe/M951.cpp @@ -54,6 +54,21 @@ void mpe_settings_init() { mpe_settings_report(); } +/** + * M951: Magnetic Parking Extruder + * + * Parameters: + * L : Set X[0] position + * R : Set X[1] position + * I : Set grab distance + * J : Set slow feedrate + * H : Set fast feedrate + * D : Set travel feedrate + * C : Set compensation factor + * + * With no parameters report the current settings. + * + */ void GcodeSuite::M951() { if (parser.seenval('L')) mpe_settings.parking_xpos[0] = parser.value_linear_units(); if (parser.seenval('R')) mpe_settings.parking_xpos[1] = parser.value_linear_units(); diff --git a/Marlin/src/lcd/tft/images/time_elapsed_32x32x4.cpp b/Marlin/src/lcd/tft/images/time_elapsed_32x32x4.cpp index 74947f9ce5..9976870032 100644 --- a/Marlin/src/lcd/tft/images/time_elapsed_32x32x4.cpp +++ b/Marlin/src/lcd/tft/images/time_elapsed_32x32x4.cpp @@ -17,7 +17,8 @@ * * You should have received a copy of the GNU General Public License * along with this program. If not, see . - **/ + * + */ #include "../../../inc/MarlinConfigPre.h" diff --git a/Marlin/src/lcd/tft/images/time_remaining_32x32x4.cpp b/Marlin/src/lcd/tft/images/time_remaining_32x32x4.cpp index aa3db49164..60930bc2af 100644 --- a/Marlin/src/lcd/tft/images/time_remaining_32x32x4.cpp +++ b/Marlin/src/lcd/tft/images/time_remaining_32x32x4.cpp @@ -17,7 +17,8 @@ * * You should have received a copy of the GNU General Public License * along with this program. If not, see . - **/ + * + */ #include "../../../inc/MarlinConfigPre.h" diff --git a/Marlin/src/sd/SdBaseFile.cpp b/Marlin/src/sd/SdBaseFile.cpp index f878118d2f..3963043ca6 100644 --- a/Marlin/src/sd/SdBaseFile.cpp +++ b/Marlin/src/sd/SdBaseFile.cpp @@ -253,7 +253,7 @@ bool SdBaseFile::exists(const char *name) { * * \return For success fgets() returns the length of the string in \a str. * If no data is read, fgets() returns zero for EOF or -1 if an error occurred. - **/ + */ int16_t SdBaseFile::fgets(char *str, int16_t num, char *delim) { char ch; int16_t n = 0; diff --git a/buildroot/share/cmake/CMakeLists.txt b/buildroot/share/cmake/CMakeLists.txt index 09b5b6f1bf..5f15d26680 100644 --- a/buildroot/share/cmake/CMakeLists.txt +++ b/buildroot/share/cmake/CMakeLists.txt @@ -20,7 +20,7 @@ cmake_minimum_required(VERSION 3.5) # and add the path to the module path # #====================================================================# -set(SCRIPT_BRANCH 1.0.2) #Set to wanted marlin-cmake release tag or branch +set(SCRIPT_BRANCH 1.0.2) # Set to wanted marlin-cmake release tag or branch if(NOT EXISTS ${CMAKE_CURRENT_LIST_DIR}/marlin-cmake) @@ -88,7 +88,7 @@ file(WRITE "${CMAKE_CURRENT_LIST_DIR}/marlin-cmake/Platform/Arduino.cmake" "${NE set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_LIST_DIR}/marlin-cmake/modules) #====================================================================# -# Custom path to Arduino SDK can be set here. # +# Custom path to Arduino SDK can be set here # # It can also be set from command line. eg.: # # cmake .. -DARDUINO_SDK_PATH="/path/to/arduino-1.x.x" # #====================================================================# @@ -113,14 +113,14 @@ set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_LIST_DIR}/marlin-cmake/toolchain/Arduin # If you receive this error: # # 'Unknown CMake command "_cmake_record_install_prefix".' # # # -# Go to the file in your CMake directory. # +# Go to the file in your CMake directory # # # # For Windows: cmake\Modules\Platform\WindowsPaths.cmake # # For Linux: cmake/Modules/Platform/UnixPaths.cmake # # # # Comment out "_cmake_record_install_prefix()" # # - OR - # -# Add "include(CMakeSystemSpecificInformation)" above the line. # +# Add "include(CMakeSystemSpecificInformation)" above the line # # # #====================================================================# project(Marlin C CXX)