Skip to content

Commit

Permalink
📝 Update some G-code and other comments (#27034)
Browse files Browse the repository at this point in the history
  • Loading branch information
classicrocker883 authored May 20, 2024
1 parent 5561baf commit 6c018eb
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 12 deletions.
14 changes: 10 additions & 4 deletions Marlin/src/feature/bedlevel/bdl/bdl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions Marlin/src/gcode/bedlevel/G42.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@

/**
* G42: Move X & Y axes to mesh coordinates (I & J)
*
* Parameters:
* F<feedrate> : Feedrate in mm/min
* I<index> : X axis point index
* J<index> : Y axis point index
* P<bool> : Flag to put the prove at the given point
*/
void GcodeSuite::G42() {
if (MOTION_CONDITIONS) {
Expand Down
2 changes: 1 addition & 1 deletion Marlin/src/gcode/probe/G38.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
15 changes: 15 additions & 0 deletions Marlin/src/gcode/probe/M951.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,21 @@ void mpe_settings_init() {
mpe_settings_report();
}

/**
* M951: Magnetic Parking Extruder
*
* Parameters:
* L<linear> : Set X[0] position
* R<linear> : Set X[1] position
* I<linear> : Set grab distance
* J<feedrate> : Set slow feedrate
* H<feedrate> : Set fast feedrate
* D<feedrate> : Set travel feedrate
* C<factor> : 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();
Expand Down
3 changes: 2 additions & 1 deletion Marlin/src/lcd/tft/images/time_elapsed_32x32x4.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
**/
*
*/

#include "../../../inc/MarlinConfigPre.h"

Expand Down
3 changes: 2 additions & 1 deletion Marlin/src/lcd/tft/images/time_remaining_32x32x4.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
**/
*
*/

#include "../../../inc/MarlinConfigPre.h"

Expand Down
2 changes: 1 addition & 1 deletion Marlin/src/sd/SdBaseFile.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
8 changes: 4 additions & 4 deletions buildroot/share/cmake/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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" #
#====================================================================#
Expand All @@ -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)
Expand Down

0 comments on commit 6c018eb

Please sign in to comment.