marlin/Marlin/src/feature/bedlevel/mbl/mesh_bed_leveling.cpp

/**
 * Marlin 3D Printer Firmware
 * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
 *
 * Based on Sprinter and grbl.
 * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include "../../../inc/MarlinConfig.h"

#if ENABLED(MESH_BED_LEVELING)

  #include "../bedlevel.h"

  #include "../../../module/motion.h"

  #if ENABLED(EXTENSIBLE_UI)
    #include "../../../lcd/extui/ui_api.h"
  #endif

  mesh_bed_leveling mbl;

  float mesh_bed_leveling::z_offset,
        mesh_bed_leveling::z_values[GRID_MAX_POINTS_X][GRID_MAX_POINTS_Y],
        mesh_bed_leveling::index_to_xpos[GRID_MAX_POINTS_X],
        mesh_bed_leveling::index_to_ypos[GRID_MAX_POINTS_Y];

  mesh_bed_leveling::mesh_bed_leveling() {
    LOOP_L_N(i, GRID_MAX_POINTS_X)
      index_to_xpos[i] = MESH_MIN_X + i * (MESH_X_DIST);
    LOOP_L_N(i, GRID_MAX_POINTS_Y)
      index_to_ypos[i] = MESH_MIN_Y + i * (MESH_Y_DIST);
    reset();
  }

  void mesh_bed_leveling::reset() {
    z_offset = 0;
    ZERO(z_values);
    #if ENABLED(EXTENSIBLE_UI)
      GRID_LOOP(x, y) ExtUI::onMeshUpdate(x, y, 0);
    #endif
  }

  #if IS_CARTESIAN && DISABLED(SEGMENT_LEVELED_MOVES)

    /**
     * Prepare a mesh-leveled linear move in a Cartesian setup,
     * splitting the move where it crosses mesh borders.
     */
    void mesh_bed_leveling::line_to_destination(const feedRate_t &scaled_fr_mm_s, uint8_t x_splits, uint8_t y_splits) {
      // Get current and destination cells for this line
      xy_int8_t scel = cell_indexes(current_position), ecel = cell_indexes(destination);
      NOMORE(scel.x, GRID_MAX_POINTS_X - 2);
      NOMORE(scel.y, GRID_MAX_POINTS_Y - 2);
      NOMORE(ecel.x, GRID_MAX_POINTS_X - 2);
      NOMORE(ecel.y, GRID_MAX_POINTS_Y - 2);

      // Start and end in the same cell? No split needed.
      if (scel == ecel) {
        line_to_destination(scaled_fr_mm_s);
        current_position = destination;
        return;
      }

      #define MBL_SEGMENT_END(A) (current_position.A + (destination.A - current_position.A) * normalized_dist)

      float normalized_dist;
      xyze_pos_t dest;
      const int8_t gcx = _MAX(scel.x, ecel.x), gcy = _MAX(scel.y, ecel.y);

      // Crosses on the X and not already split on this X?
      // The x_splits flags are insurance against rounding errors.
      if (ecel.x != scel.x && TEST(x_splits, gcx)) {
        // Split on the X grid line
        CBI(x_splits, gcx);
        dest = destination;
        destination.x = index_to_xpos[gcx];
        normalized_dist = (destination.x - current_position.x) / (dest.x - current_position.x);
        destination.y = MBL_SEGMENT_END(y);
      }
      // Crosses on the Y and not already split on this Y?
      else if (ecel.y != scel.y && TEST(y_splits, gcy)) {
        // Split on the Y grid line
        CBI(y_splits, gcy);
        dest = destination;
        destination.y = index_to_ypos[gcy];
        normalized_dist = (destination.y - current_position.y) / (dest.y - current_position.y);
        destination.x = MBL_SEGMENT_END(x);
      }
      else {
        // Must already have been split on these border(s)
        // This should be a rare case.
        line_to_destination(scaled_fr_mm_s);
        current_position = destination;
        return;
      }

      destination.z = MBL_SEGMENT_END(z);
      destination.e = MBL_SEGMENT_END(e);

      // Do the split and look for more borders
      line_to_destination(scaled_fr_mm_s, x_splits, y_splits);

      // Restore destination from stack
      destination = dest;
      line_to_destination(scaled_fr_mm_s, x_splits, y_splits);
    }

  #endif // IS_CARTESIAN && !SEGMENT_LEVELED_MOVES

  void mesh_bed_leveling::report_mesh() {
    SERIAL_ECHOPAIR_F(STRINGIFY(GRID_MAX_POINTS_X) "x" STRINGIFY(GRID_MAX_POINTS_Y) " mesh. Z offset: ", z_offset, 5);
    SERIAL_ECHOLNPGM("\nMeasured points:");
    print_2d_array(GRID_MAX_POINTS_X, GRID_MAX_POINTS_Y, 5,
      [](const uint8_t ix, const uint8_t iy) { return z_values[ix][iy]; }
    );
  }

#endif // MESH_BED_LEVELING