Move 'libs' files

2017-09-06 06:28:30 -05:00
parent cc92e544a5
commit efa578d6b0
16 changed files with 0 additions and 0 deletions
--- a/Marlin/src/libs/nozzle.h
+++ b/Marlin/src/libs/nozzle.h
@@ -0,0 +1,109 @@
+/**
+ * Marlin 3D Printer Firmware
+ * Copyright (C) 2016 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/>.
+ *
+ */
+
+#ifndef __NOZZLE_H__
+#define __NOZZLE_H__
+
+#include "Marlin.h"
+#include "point_t.h"
+
+#if ENABLED(NOZZLE_CLEAN_FEATURE)
+  constexpr float nozzle_clean_start_point[4] = NOZZLE_CLEAN_START_POINT,
+                  nozzle_clean_end_point[4] = NOZZLE_CLEAN_END_POINT,
+                  nozzle_clean_length = FABS(nozzle_clean_start_point[X_AXIS] - nozzle_clean_end_point[X_AXIS]), //abs x size of wipe pad
+                  nozzle_clean_height = FABS(nozzle_clean_start_point[Y_AXIS] - nozzle_clean_end_point[Y_AXIS]); //abs y size of wipe pad
+  constexpr bool nozzle_clean_horizontal = nozzle_clean_length >= nozzle_clean_height; //whether to zig-zag horizontally or vertically
+#endif // NOZZLE_CLEAN_FEATURE
+
+/**
+ * @brief Nozzle class
+ *
+ * @todo: Do not ignore the end.z value and allow XYZ movements
+ */
+class Nozzle {
+  private:
+    /**
+     * @brief Stroke clean pattern
+     * @details Wipes the nozzle back and forth in a linear movement
+     *
+     * @param start point_t defining the starting point
+     * @param end point_t defining the ending point
+     * @param strokes number of strokes to execute
+     */
+    static void stroke(
+      _UNUSED point_t const &start,
+      _UNUSED point_t const &end,
+      _UNUSED uint8_t const &strokes
+    ) _Os;
+
+    /**
+     * @brief Zig-zag clean pattern
+     * @details Apply a zig-zag cleaning pattern
+     *
+     * @param start point_t defining the starting point
+     * @param end point_t defining the ending point
+     * @param strokes number of strokes to execute
+     * @param objects number of objects to create
+     */
+    static void zigzag(
+      _UNUSED point_t const &start,
+      _UNUSED point_t const &end,
+      _UNUSED uint8_t const &strokes,
+      _UNUSED uint8_t const &objects
+    ) _Os;
+
+    /**
+     * @brief Circular clean pattern
+     * @details Apply a circular cleaning pattern
+     *
+     * @param start point_t defining the middle of circle
+     * @param strokes number of strokes to execute
+     * @param radius radius of circle
+     */
+    static void circle(
+      _UNUSED point_t const &start,
+      _UNUSED point_t const &middle,
+      _UNUSED uint8_t const &strokes,
+      _UNUSED float const &radius
+    ) _Os;
+
+  public:
+    /**
+     * @brief Clean the nozzle
+     * @details Starts the selected clean procedure pattern
+     *
+     * @param pattern one of the available patterns
+     * @param argument depends on the cleaning pattern
+     */
+    static void clean(
+      _UNUSED uint8_t const &pattern,
+      _UNUSED uint8_t const &strokes,
+      _UNUSED float const &radius,
+      _UNUSED uint8_t const &objects = 0
+    ) _Os;
+
+    static void park(
+      _UNUSED uint8_t const &z_action
+    ) _Os;
+};
+
+#endif