My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

printcounter.h 5.0KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /*
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #ifndef PRINTCOUNTER_H
  23. #define PRINTCOUNTER_H
  24. #include "macros.h"
  25. #include "language.h"
  26. #include "stopwatch.h"
  27. #include <avr/eeprom.h>
  28. // Print debug messages with M111 S2
  29. //#define DEBUG_PRINTCOUNTER
  30. struct printStatistics { // 13 bytes
  31. //const uint8_t magic; // Magic header, it will always be 0x16
  32. uint16_t totalPrints; // Number of prints
  33. uint16_t finishedPrints; // Number of complete prints
  34. uint32_t printTime; // Accumulated printing time
  35. uint32_t longestPrint; // Longest successfull print job
  36. double filamentUsed; // Accumulated filament consumed in mm
  37. };
  38. class PrintCounter: public Stopwatch {
  39. private:
  40. typedef Stopwatch super;
  41. printStatistics data;
  42. /**
  43. * @brief EEPROM address
  44. * @details Defines the start offset address where the data is stored.
  45. */
  46. const uint16_t address = 0x32;
  47. /**
  48. * @brief Interval in seconds between counter updates
  49. * @details This const value defines what will be the time between each
  50. * accumulator update. This is different from the EEPROM save interval.
  51. *
  52. * @note The max value for this option is 60(s), otherwise integer
  53. * overflow will happen.
  54. */
  55. const uint16_t updateInterval = 10;
  56. /**
  57. * @brief Interval in seconds between EEPROM saves
  58. * @details This const value defines what will be the time between each
  59. * EEPROM save cycle, the development team recommends to set this value
  60. * no lower than 3600 secs (1 hour).
  61. */
  62. const uint16_t saveInterval = 3600;
  63. /**
  64. * @brief Timestamp of the last call to deltaDuration()
  65. * @details Stores the timestamp of the last deltaDuration(), this is
  66. * required due to the updateInterval cycle.
  67. */
  68. millis_t lastDuration;
  69. /**
  70. * @brief Stats were loaded from EERPROM
  71. * @details If set to true it indicates if the statistical data was already
  72. * loaded from the EEPROM.
  73. */
  74. bool loaded = false;
  75. protected:
  76. /**
  77. * @brief dT since the last call
  78. * @details Returns the elapsed time in seconds since the last call, this is
  79. * used internally for print statistics accounting is not intended to be a
  80. * user callable function.
  81. */
  82. millis_t deltaDuration();
  83. public:
  84. /**
  85. * @brief Class constructor
  86. */
  87. PrintCounter();
  88. /**
  89. * @brief Checks if Print Statistics has been loaded
  90. * @details Returns true if the statistical data has been loaded.
  91. * @return bool
  92. */
  93. bool isLoaded();
  94. /**
  95. * @brief Increments the total filament used
  96. * @details The total filament used counter will be incremented by "amount".
  97. *
  98. * @param amount The amount of filament used in mm
  99. */
  100. void incFilamentUsed(double const &amount);
  101. /**
  102. * @brief Resets the Print Statistics
  103. * @details Resets the statistics to zero and saves them to EEPROM creating
  104. * also the magic header.
  105. */
  106. void initStats();
  107. /**
  108. * @brief Loads the Print Statistics
  109. * @details Loads the statistics from EEPROM
  110. */
  111. void loadStats();
  112. /**
  113. * @brief Saves the Print Statistics
  114. * @details Saves the statistics to EEPROM
  115. */
  116. void saveStats();
  117. /**
  118. * @brief Serial output the Print Statistics
  119. * @details This function may change in the future, for now it directly
  120. * prints the statistical data to serial.
  121. */
  122. void showStats();
  123. /**
  124. * @brief Return the currently loaded statistics
  125. * @details Return the raw data, in the same structure used internally
  126. */
  127. printStatistics getStats() { return this->data; }
  128. /**
  129. * @brief Loop function
  130. * @details This function should be called at loop, it will take care of
  131. * periodically save the statistical data to EEPROM and do time keeping.
  132. */
  133. void tick();
  134. /**
  135. * The following functions are being overridden
  136. */
  137. bool start();
  138. bool stop();
  139. void reset();
  140. #if ENABLED(DEBUG_PRINTCOUNTER)
  141. /**
  142. * @brief Prints a debug message
  143. * @details Prints a simple debug message "PrintCounter::function"
  144. */
  145. static void debug(const char func[]);
  146. #endif
  147. };
  148. #endif // PRINTCOUNTER_H