mmu2_reporting.cpp 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. #include "mmu2.h"
  2. #include "mmu2_reporting.h"
  3. #include "mmu2_error_converter.h"
  4. #include "mmu2/error_codes.h"
  5. #include "mmu2/buttons.h"
  6. #include "ultralcd.h"
  7. #include "Filament_sensor.h"
  8. #include "language.h"
  9. #include "temperature.h"
  10. #include "sound.h"
  11. namespace MMU2 {
  12. const char * ProgressCodeToText(uint16_t pc); // we may join progress convertor and reporter together
  13. void BeginReport(CommandInProgress /*cip*/, uint16_t ec) {
  14. custom_message_type = CustomMsg::MMUProgress;
  15. lcd_setstatuspgm( _T(ProgressCodeToText(ec)) );
  16. }
  17. void EndReport(CommandInProgress /*cip*/, uint16_t /*ec*/) {
  18. // clear the status msg line - let the printed filename get visible again
  19. custom_message_type = CustomMsg::Status;
  20. }
  21. /**
  22. * @brief Renders any characters that will be updated live on the MMU error screen.
  23. *Currently, this is FINDA and Filament Sensor status and Extruder temperature.
  24. */
  25. extern void ReportErrorHookDynamicRender(void){
  26. // beware - this optimization abuses the fact, that FindaDetectsFilament returns 0 or 1 and '0' is followed by '1' in the ASCII table
  27. lcd_putc_at(3, 2, mmu2.FindaDetectsFilament() + '0');
  28. lcd_putc_at(8, 2, fsensor.getFilamentPresent() + '0');
  29. // print active/changing filament slot
  30. lcd_set_cursor(10, 2);
  31. lcdui_print_extruder();
  32. // Print active extruder temperature
  33. lcd_set_cursor(16, 2);
  34. lcd_printf_P(PSTR("%3d"), (int)(degHotend(0) + 0.5));
  35. }
  36. /**
  37. * @brief Renders any characters that are static on the MMU error screen i.e. they don't change.
  38. * @param[in] ei Error code index
  39. */
  40. static void ReportErrorHookStaticRender(uint8_t ei) {
  41. //! Show an error screen
  42. //! When an MMU error occurs, the LCD content will look like this:
  43. //! |01234567890123456789|
  44. //! |MMU FW update needed| <- title/header of the error: max 20 characters
  45. //! |prusa3d.com/ERR04504| <- URL 20 characters
  46. //! |FI:1 FS:1 5>3 t201°| <- status line, t is thermometer symbol
  47. //! |>Retry >Done >W| <- buttons
  48. bool two_choices = false;
  49. // Read and determine what operations should be shown on the menu
  50. const uint8_t button_operation = PrusaErrorButtons(ei);
  51. const uint8_t button_op_right = BUTTON_OP_RIGHT(button_operation);
  52. const uint8_t button_op_middle = BUTTON_OP_MIDDLE(button_operation);
  53. // Check if the menu should have three or two choices
  54. if (button_op_right == (uint8_t)ButtonOperations::NoOperation){
  55. // Two operations not specified, the error menu should only show two choices
  56. two_choices = true;
  57. }
  58. lcd_set_custom_characters_nextpage();
  59. lcd_update_enable(false);
  60. lcd_clear();
  61. // Print title and header
  62. lcd_printf_P(PSTR("%.20S\nprusa3d.com/ERR04%hu"), _T(PrusaErrorTitle(ei)), PrusaErrorCode(ei) );
  63. ReportErrorHookSensorLineRender();
  64. // Render the choices
  65. lcd_show_choices_prompt_P(two_choices ? LCD_LEFT_BUTTON_CHOICE : LCD_MIDDLE_BUTTON_CHOICE, _T(PrusaErrorButtonTitle(button_op_middle)), _T(two_choices ? PrusaErrorButtonMore() : PrusaErrorButtonTitle(button_op_right)), two_choices ? 18 : 9, two_choices ? nullptr : _T(PrusaErrorButtonMore()));
  66. }
  67. extern void ReportErrorHookSensorLineRender()
  68. {
  69. // Render static characters in third line
  70. lcd_set_cursor(0, 2);
  71. lcd_printf_P(PSTR("FI: FS: > %c %c"), LCD_STR_THERMOMETER[0], LCD_STR_DEGREE[0]);
  72. }
  73. /**
  74. * @brief Monitors the LCD button selection without blocking MMU communication
  75. * @param[in] ei Error code index
  76. * @return 0 if there is no knob click --
  77. * 1 if user clicked 'More' and firmware should render
  78. * the error screen when ReportErrorHook is called next --
  79. * 2 if the user selects an operation and we would like
  80. * to exit the error screen. The MMU will raise the menu
  81. * again if the error is not solved.
  82. */
  83. static uint8_t ReportErrorHookMonitor(uint8_t ei) {
  84. uint8_t ret = 0;
  85. bool two_choices = false;
  86. static int8_t enc_dif = lcd_encoder_diff;
  87. if (lcd_encoder_diff == 0)
  88. {
  89. // lcd_update_enable(true) was called outside ReportErrorHookMonitor
  90. // It will set lcd_encoder_diff to 0, sync enc_dif
  91. enc_dif = 0;
  92. }
  93. // Read and determine what operations should be shown on the menu
  94. const uint8_t button_operation = PrusaErrorButtons(ei);
  95. const uint8_t button_op_right = BUTTON_OP_RIGHT(button_operation);
  96. const uint8_t button_op_middle = BUTTON_OP_MIDDLE(button_operation);
  97. // Check if the menu should have three or two choices
  98. if (button_op_right == (uint8_t)ButtonOperations::NoOperation){
  99. // Two operations not specified, the error menu should only show two choices
  100. two_choices = true;
  101. }
  102. static int8_t current_selection = two_choices ? LCD_LEFT_BUTTON_CHOICE : LCD_MIDDLE_BUTTON_CHOICE;
  103. static int8_t choice_selected = -1;
  104. // Check if knob was rotated
  105. if (abs(enc_dif - lcd_encoder_diff) >= ENCODER_PULSES_PER_STEP) {
  106. if (two_choices == false) { // third_choice is not nullptr, safe to dereference
  107. if (enc_dif > lcd_encoder_diff && current_selection != LCD_LEFT_BUTTON_CHOICE) {
  108. // Rotating knob counter clockwise
  109. current_selection--;
  110. } else if (enc_dif < lcd_encoder_diff && current_selection != LCD_RIGHT_BUTTON_CHOICE) {
  111. // Rotating knob clockwise
  112. current_selection++;
  113. }
  114. } else {
  115. if (enc_dif > lcd_encoder_diff && current_selection != LCD_LEFT_BUTTON_CHOICE) {
  116. // Rotating knob counter clockwise
  117. current_selection = LCD_LEFT_BUTTON_CHOICE;
  118. } else if (enc_dif < lcd_encoder_diff && current_selection != LCD_MIDDLE_BUTTON_CHOICE) {
  119. // Rotating knob clockwise
  120. current_selection = LCD_MIDDLE_BUTTON_CHOICE;
  121. }
  122. }
  123. // Update '>' render only
  124. //! @brief Button menu
  125. //!
  126. //! @code{.unparsed}
  127. //! |01234567890123456789|
  128. //! | |
  129. //! | |
  130. //! | |
  131. //! |>(left) |
  132. //! ----------------------
  133. //! Three choices
  134. //! |>(left)>(mid)>(righ)|
  135. //! ----------------------
  136. //! Two choices
  137. //! ----------------------
  138. //! |>(left) >(mid) |
  139. //! ----------------------
  140. //! @endcode
  141. //
  142. lcd_set_cursor(0, 3);
  143. lcd_print(current_selection == LCD_LEFT_BUTTON_CHOICE ? '>': ' ');
  144. if (two_choices == false)
  145. {
  146. lcd_set_cursor(9, 3);
  147. lcd_print(current_selection == LCD_MIDDLE_BUTTON_CHOICE ? '>': ' ');
  148. lcd_set_cursor(18, 3);
  149. lcd_print(current_selection == LCD_RIGHT_BUTTON_CHOICE ? '>': ' ');
  150. } else {
  151. // More button for two button screen
  152. lcd_set_cursor(18, 3);
  153. lcd_print(current_selection == LCD_MIDDLE_BUTTON_CHOICE ? '>': ' ');
  154. }
  155. // Consume rotation event and make feedback sound
  156. enc_dif = lcd_encoder_diff;
  157. Sound_MakeSound(e_SOUND_TYPE_EncoderMove);
  158. }
  159. // Check if knob was clicked and consume the event
  160. if (lcd_clicked()) {
  161. Sound_MakeSound(e_SOUND_TYPE_ButtonEcho);
  162. choice_selected = current_selection;
  163. } else {
  164. // continue monitoring
  165. return ret;
  166. }
  167. if ((two_choices && choice_selected == LCD_MIDDLE_BUTTON_CHOICE) // Two choices and middle button selected
  168. || (!two_choices && choice_selected == LCD_RIGHT_BUTTON_CHOICE)) // Three choices and right most button selected
  169. {
  170. // 'More' show error description
  171. lcd_show_fullscreen_message_and_wait_P(_T(PrusaErrorDesc(ei)));
  172. ret = 1;
  173. } else if(choice_selected == LCD_MIDDLE_BUTTON_CHOICE) {
  174. SetButtonResponse((ButtonOperations)button_op_right);
  175. ret = 2;
  176. } else {
  177. SetButtonResponse((ButtonOperations)button_op_middle);
  178. ret = 2;
  179. }
  180. // Reset static variables to their default value
  181. current_selection = two_choices ? LCD_LEFT_BUTTON_CHOICE : LCD_MIDDLE_BUTTON_CHOICE;
  182. choice_selected = -1;
  183. return ret;
  184. }
  185. enum class ReportErrorHookStates : uint8_t {
  186. RENDER_ERROR_SCREEN = 0,
  187. MONITOR_SELECTION = 1,
  188. DISMISS_ERROR_SCREEN = 2,
  189. };
  190. enum ReportErrorHookStates ReportErrorHookState = ReportErrorHookStates::RENDER_ERROR_SCREEN;
  191. void ReportErrorHook(uint16_t ec) {
  192. if (mmu2.MMUCurrentErrorCode() == ErrorCode::OK && mmu2.MMULastErrorSource() == MMU2::ErrorSourceMMU)
  193. {
  194. // If the error code suddenly changes to OK, that means
  195. // a button was pushed on the MMU and the LCD should
  196. // dismiss the error screen until MMU raises a new error
  197. ReportErrorHookState = ReportErrorHookStates::DISMISS_ERROR_SCREEN;
  198. } else {
  199. // attempt an automatic Retry button
  200. if( ReportErrorHookState == ReportErrorHookStates::MONITOR_SELECTION ){
  201. if( mmu2.RetryIfPossible(ec) ){
  202. ReportErrorHookState = ReportErrorHookStates::DISMISS_ERROR_SCREEN;
  203. }
  204. }
  205. }
  206. const uint8_t ei = PrusaErrorCodeIndex(ec);
  207. switch ((uint8_t)ReportErrorHookState)
  208. {
  209. case (uint8_t)ReportErrorHookStates::RENDER_ERROR_SCREEN:
  210. ReportErrorHookStaticRender(ei);
  211. ReportErrorHookState = ReportErrorHookStates::MONITOR_SELECTION;
  212. // Fall through
  213. case (uint8_t)ReportErrorHookStates::MONITOR_SELECTION:
  214. mmu2.is_mmu_error_monitor_active = true;
  215. ReportErrorHookDynamicRender(); // Render dynamic characters
  216. switch (ReportErrorHookMonitor(ei))
  217. {
  218. case 0:
  219. // No choice selected, return to loop()
  220. break;
  221. case 1:
  222. // More button selected, change state
  223. ReportErrorHookState = ReportErrorHookStates::RENDER_ERROR_SCREEN;
  224. break;
  225. case 2:
  226. // Exit error screen and enable lcd updates
  227. lcd_set_custom_characters();
  228. lcd_update_enable(true);
  229. lcd_return_to_status();
  230. // Reset the state in case a new error is reported
  231. mmu2.is_mmu_error_monitor_active = false;
  232. ReportErrorHookState = ReportErrorHookStates::RENDER_ERROR_SCREEN;
  233. break;
  234. default:
  235. break;
  236. }
  237. return; // Always return to loop() to let MMU trigger a call to ReportErrorHook again
  238. break;
  239. case (uint8_t)ReportErrorHookStates::DISMISS_ERROR_SCREEN:
  240. lcd_set_custom_characters();
  241. lcd_update_enable(true);
  242. lcd_return_to_status();
  243. // Reset the state in case a new error is reported
  244. mmu2.is_mmu_error_monitor_active = false;
  245. ReportErrorHookState = ReportErrorHookStates::RENDER_ERROR_SCREEN;
  246. break;
  247. default:
  248. break;
  249. }
  250. }
  251. void ReportProgressHook(CommandInProgress cip, uint16_t ec) {
  252. if (cip != CommandInProgress::NoCommand)
  253. {
  254. custom_message_type = CustomMsg::MMUProgress;
  255. lcd_setstatuspgm( _T(ProgressCodeToText(ec)) );
  256. } else {
  257. // If there is no command in progress we can display other
  258. // useful information such as the name of the SD file
  259. // being printed
  260. custom_message_type = CustomMsg::Status;
  261. }
  262. }
  263. } // namespace MMU2