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 4.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  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 "stopwatch.h"
  26. #include <avr/eeprom.h>
  27. // Print debug messages with M111 S2
  28. //#define DEBUG_PRINTCOUNTER
  29. struct printStatistics { // 13 bytes
  30. //const uint8_t magic; // Magic header, it will always be 0x16
  31. uint16_t totalPrints; // Number of prints
  32. uint16_t finishedPrints; // Number of complete prints
  33. millis_t printTime; // Total printing time
  34. millis_t longestPrint; // Longest print job - not in use
  35. };
  36. class PrintCounter: public Stopwatch {
  37. private:
  38. typedef Stopwatch super;
  39. printStatistics data;
  40. /**
  41. * @brief EEPROM address
  42. * @details Defines the start offset address where the data is stored.
  43. */
  44. const uint16_t address = 0x32;
  45. /**
  46. * @brief Interval in seconds between counter updates
  47. * @details This const value defines what will be the time between each
  48. * accumulator update. This is different from the EEPROM save interval.
  49. *
  50. * @note The max value for this option is 60(s), otherwise integer
  51. * overflow will happen.
  52. */
  53. const uint16_t updateInterval = 10;
  54. /**
  55. * @brief Interval in seconds between EEPROM saves
  56. * @details This const value defines what will be the time between each
  57. * EEPROM save cycle, the development team recommends to set this value
  58. * no lower than 3600 secs (1 hour).
  59. */
  60. const uint16_t saveInterval = 3600;
  61. /**
  62. * @brief Timestamp of the last call to deltaDuration()
  63. * @details Stores the timestamp of the last deltaDuration(), this is
  64. * required due to the updateInterval cycle.
  65. */
  66. millis_t lastDuration;
  67. /**
  68. * @brief Stats were loaded from EERPROM
  69. * @details If set to true it indicates if the statistical data was already
  70. * loaded from the EEPROM.
  71. */
  72. bool loaded = false;
  73. protected:
  74. /**
  75. * @brief dT since the last call
  76. * @details Returns the elapsed time in seconds since the last call, this is
  77. * used internally for print statistics accounting is not intended to be a
  78. * user callable function.
  79. */
  80. millis_t deltaDuration();
  81. public:
  82. /**
  83. * @brief Class constructor
  84. */
  85. PrintCounter();
  86. /**
  87. * @brief Checks if Print Statistics has been loaded
  88. * @details Returns true if the statistical data has been loaded.
  89. * @return bool
  90. */
  91. bool isLoaded();
  92. /**
  93. * @brief Resets the Print Statistics
  94. * @details Resets the statistics to zero and saves them to EEPROM creating
  95. * also the magic header.
  96. */
  97. void initStats();
  98. /**
  99. * @brief Loads the Print Statistics
  100. * @details Loads the statistics from EEPROM
  101. */
  102. void loadStats();
  103. /**
  104. * @brief Saves the Print Statistics
  105. * @details Saves the statistics to EEPROM
  106. */
  107. void saveStats();
  108. /**
  109. * @brief Serial output the Print Statistics
  110. * @details This function may change in the future, for now it directly
  111. * prints the statistical data to serial.
  112. */
  113. void showStats();
  114. /**
  115. * @brief Return the currently loaded statistics
  116. * @details Return the raw data, in the same structure used internally
  117. */
  118. printStatistics getStats() { return this->data; }
  119. /**
  120. * @brief Loop function
  121. * @details This function should be called at loop, it will take care of
  122. * periodically save the statistical data to EEPROM and do time keeping.
  123. */
  124. void tick();
  125. /**
  126. * The following functions are being overridden
  127. */
  128. bool start();
  129. bool stop();
  130. void reset();
  131. #if ENABLED(DEBUG_PRINTCOUNTER)
  132. /**
  133. * @brief Prints a debug message
  134. * @details Prints a simple debug message "PrintCounter::function"
  135. */
  136. static void debug(const char func[]);
  137. #endif
  138. };
  139. #endif // PRINTCOUNTER_H