🧑‍💻 ExtUI::onPlayTone optional duration

thinkyhead · thinkyhead · commit 22fc07d72ba0 · 2024-01-22T00:04:08.000-06:00
diff --git a/Marlin/src/lcd/extui/anycubic_chiron/chiron_extui.cpp b/Marlin/src/lcd/extui/anycubic_chiron/chiron_extui.cpp
@@ -49,7 +49,7 @@ namespace ExtUI {
   void onMediaError()    { chiron.mediaEvent(AC_media_error);    }
   void onMediaRemoved()  { chiron.mediaEvent(AC_media_removed);  }
 
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
     #if ENABLED(SPEAKER)
       ::tone(BEEPER_PIN, frequency, duration);
     #endif
diff --git a/Marlin/src/lcd/extui/anycubic_i3mega/anycubic_extui.cpp b/Marlin/src/lcd/extui/anycubic_i3mega/anycubic_extui.cpp
@@ -41,7 +41,7 @@ namespace ExtUI {
   void onMediaInserted()  { anycubicTFT.onSDCardStateChange(true); }
   void onMediaError()     { anycubicTFT.onSDCardError(); }
   void onMediaRemoved()   { anycubicTFT.onSDCardStateChange(false); }
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
     TERN_(SPEAKER, ::tone(BEEPER_PIN, frequency, duration));
   }
   void onPrintTimerStarted()  { anycubicTFT.onPrintTimerStarted(); }
diff --git a/Marlin/src/lcd/extui/anycubic_vyper/vyper_extui.cpp b/Marlin/src/lcd/extui/anycubic_vyper/vyper_extui.cpp
@@ -49,7 +49,7 @@ namespace ExtUI {
   void onMediaError()    { dgus.mediaEvent(AC_media_error);    }
   void onMediaRemoved()  { dgus.mediaEvent(AC_media_removed);  }
 
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
     #if ENABLED(SPEAKER)
       ::tone(BEEPER_PIN, frequency, duration);
     #endif
diff --git a/Marlin/src/lcd/extui/dgus/dgus_extui.cpp b/Marlin/src/lcd/extui/dgus/dgus_extui.cpp
@@ -52,7 +52,7 @@ namespace ExtUI {
   void onMediaError()    { TERN_(HAS_MEDIA, screen.sdCardError()); }
   void onMediaRemoved()  { TERN_(HAS_MEDIA, screen.sdCardRemoved()); }
 
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {}
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {}
   void onPrintTimerStarted() {}
   void onPrintTimerPaused() {}
   void onPrintTimerStopped() {}
diff --git a/Marlin/src/lcd/extui/dgus/mks/DGUSDisplayDef.cpp b/Marlin/src/lcd/extui/dgus/mks/DGUSDisplayDef.cpp
@@ -33,7 +33,7 @@
 #include "../../../../module/planner.h"
 
 #include "../../ui_api.h"
-#include "../../../marlinui.h"
+#include "../../../marlinui.h" // For material presets
 
 #if HAS_STEALTHCHOP
   #include "../../../../module/stepper/trinamic.h"
diff --git a/Marlin/src/lcd/extui/dgus_e3s1pro/DGUSDisplay.h b/Marlin/src/lcd/extui/dgus_e3s1pro/DGUSDisplay.h
@@ -71,7 +71,7 @@ class DGUSDisplay {
     write(addr, static_cast<const void*>(&data), sizeof(T));
   }
 
-  // Until now I did not need to actively read from the display. That's why there is no ReadVariable
+  // Until now I did not need to actively read from the display. That's why there is no readVariable
   // (I extensively use the auto upload of the display)
 
   // Read GUI and OS version from screen
diff --git a/Marlin/src/lcd/extui/dgus_e3s1pro/DGUSScreenHandler.cpp b/Marlin/src/lcd/extui/dgus_e3s1pro/DGUSScreenHandler.cpp
@@ -281,7 +281,7 @@ void DGUSScreenHandler::configurationStoreRead(bool success) {
   }
 }
 
-void DGUSScreenHandler::playTone(const uint16_t frequency, const uint16_t duration) {
+void DGUSScreenHandler::playTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
   if (WITHIN(frequency, 1, 255)) {
     if (WITHIN(duration, 1, 255))
       dgus.playSound((uint8_t)frequency, (uint8_t)duration);
diff --git a/Marlin/src/lcd/extui/dgus_e3s1pro/DGUSScreenHandler.h b/Marlin/src/lcd/extui/dgus_e3s1pro/DGUSScreenHandler.h
@@ -99,7 +99,7 @@ class DGUSScreenHandler {
   static void configurationStoreWritten(bool success);
   static void configurationStoreRead(bool success);
 
-  static void playTone(const uint16_t frequency, const uint16_t duration);
+  static void playTone(const uint16_t frequency, const uint16_t duration=0);
   static void angryBeeps(const uint8_t beepCount);
 
   static void levelingStart();
diff --git a/Marlin/src/lcd/extui/dgus_e3s1pro/dgus_e3s1pro_extui.cpp b/Marlin/src/lcd/extui/dgus_e3s1pro/dgus_e3s1pro_extui.cpp
@@ -59,7 +59,7 @@ namespace ExtUI {
   void onMediaError()    { TERN_(HAS_MEDIA, screen.sdCardError()); }
   void onMediaRemoved()  { TERN_(HAS_MEDIA, screen.sdCardRemoved()); }
 
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
     screen.playTone(frequency, duration);
   }
 
diff --git a/Marlin/src/lcd/extui/dgus_reloaded/DGUSDisplay.h b/Marlin/src/lcd/extui/dgus_reloaded/DGUSDisplay.h
@@ -74,7 +74,7 @@ class DGUSDisplay {
     write(addr, static_cast<const void*>(&data), sizeof(T));
   }
 
-  // Until now I did not need to actively read from the display. That's why there is no ReadVariable
+  // Until now I did not need to actively read from the display. That's why there is no readVariable
   // (I extensively use the auto upload of the display)
 
   // Read GUI and OS version from screen
diff --git a/Marlin/src/lcd/extui/dgus_reloaded/DGUSScreenHandler.cpp b/Marlin/src/lcd/extui/dgus_reloaded/DGUSScreenHandler.cpp
@@ -224,7 +224,7 @@ void DGUSScreenHandler::configurationStoreRead(bool success) {
   }
 }
 
-void DGUSScreenHandler::playTone(const uint16_t frequency, const uint16_t duration) {
+void DGUSScreenHandler::playTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
   if (WITHIN(frequency, 1, 255)) {
     if (WITHIN(duration, 1, 255))
       dgus.playSound((uint8_t)frequency, (uint8_t)duration);
diff --git a/Marlin/src/lcd/extui/dgus_reloaded/DGUSScreenHandler.h b/Marlin/src/lcd/extui/dgus_reloaded/DGUSScreenHandler.h
@@ -45,7 +45,7 @@ class DGUSScreenHandler {
   static void configurationStoreWritten(bool success);
   static void configurationStoreRead(bool success);
 
-  static void playTone(const uint16_t frequency, const uint16_t duration);
+  static void playTone(const uint16_t frequency, const uint16_t duration=0);
   static void meshUpdate(const int8_t xpos, const int8_t ypos);
   static void printTimerStarted();
   static void printTimerPaused();
diff --git a/Marlin/src/lcd/extui/dgus_reloaded/dgus_reloaded_extui.cpp b/Marlin/src/lcd/extui/dgus_reloaded/dgus_reloaded_extui.cpp
@@ -54,7 +54,7 @@ namespace ExtUI {
   void onMediaError()    { TERN_(HAS_MEDIA, screen.sdCardError()); }
   void onMediaRemoved()  { TERN_(HAS_MEDIA, screen.sdCardRemoved()); }
 
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {
     screen.playTone(frequency, duration);
   }
 
diff --git a/Marlin/src/lcd/extui/example/example.cpp b/Marlin/src/lcd/extui/example/example.cpp
@@ -50,7 +50,7 @@ namespace ExtUI {
   void onMediaInserted() {}
   void onMediaError() {}
   void onMediaRemoved() {}
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {}
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {}
   void onPrintTimerStarted() {}
   void onPrintTimerPaused() {}
   void onPrintTimerStopped() {}
diff --git a/Marlin/src/lcd/extui/ftdi_eve_touch_ui/ftdi_eve_extui.cpp b/Marlin/src/lcd/extui/ftdi_eve_touch_ui/ftdi_eve_extui.cpp
@@ -108,7 +108,7 @@ namespace ExtUI {
   }
   void onSettingsLoaded(const bool) {}
 
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) { sound.play_tone(frequency, duration); }
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) { sound.play_tone(frequency, duration); }
 
   void onUserConfirmRequired(const char * const msg) {
     if (msg)
diff --git a/Marlin/src/lcd/extui/ia_creality/ia_creality_extui.cpp b/Marlin/src/lcd/extui/ia_creality/ia_creality_extui.cpp
@@ -98,7 +98,7 @@ void onMediaRemoved() {
   }
 }
 
-void onPlayTone(const uint16_t frequency, const uint16_t duration) {
+void onPlayTone(const uint16_t, const uint16_t/*=0*/) {
   rts.sendData(StartSoundSet, SoundAddr);
 }
 
diff --git a/Marlin/src/lcd/extui/malyan/malyan_extui.cpp b/Marlin/src/lcd/extui/malyan/malyan_extui.cpp
@@ -137,7 +137,7 @@ namespace ExtUI {
   void onMediaInserted() {}
   void onMediaError() {}
   void onMediaRemoved() {}
-  void onPlayTone(const uint16_t, const uint16_t) {}
+  void onPlayTone(const uint16_t, const uint16_t/*=0*/) {}
   void onFilamentRunout(const extruder_t extruder) {}
   void onUserConfirmRequired(const char * const) {}
   void onHomingStart() {}
diff --git a/Marlin/src/lcd/extui/nextion/nextion_extui.cpp b/Marlin/src/lcd/extui/nextion/nextion_extui.cpp
@@ -41,7 +41,7 @@ namespace ExtUI {
   void onMediaInserted() {}
   void onMediaError() {}
   void onMediaRemoved() {}
-  void onPlayTone(const uint16_t frequency, const uint16_t duration) {}
+  void onPlayTone(const uint16_t frequency, const uint16_t duration/*=0*/) {}
   void onPrintTimerStarted() {}
   void onPrintTimerPaused() {}
   void onPrintTimerStopped() {}
diff --git a/Marlin/src/lcd/extui/ui_api.h b/Marlin/src/lcd/extui/ui_api.h
@@ -43,6 +43,7 @@
  ****************************************************************************/
 
 #include "../../inc/MarlinConfig.h"
+
 #include "../marlinui.h"
 #include "../../gcode/gcode.h"
 
@@ -460,7 +461,7 @@ namespace ExtUI {
   void onMediaInserted();
   void onMediaError();
   void onMediaRemoved();
-  void onPlayTone(const uint16_t frequency, const uint16_t duration);
+  void onPlayTone(const uint16_t frequency, const uint16_t duration=0);
   void onPrinterKilled(FSTR_P const error, FSTR_P const component);
   void onSurviveInKilled();
   void onPrintTimerStarted();

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ namespace ExtUI {`
`41`	`41`	`void onMediaInserted() { anycubicTFT.onSDCardStateChange(true); }`
`42`	`42`	`void onMediaError() { anycubicTFT.onSDCardError(); }`
`43`	`43`	`void onMediaRemoved() { anycubicTFT.onSDCardStateChange(false); }`
`44`		`- void onPlayTone(const uint16_t frequency, const uint16_t duration) {`
	`44`	`+ void onPlayTone(const uint16_t frequency, const uint16_t duration/=0/) {`
`45`	`45`	`TERN_(SPEAKER, ::tone(BEEPER_PIN, frequency, duration));`
`46`	`46`	`}`
`47`	`47`	`void onPrintTimerStarted() { anycubicTFT.onPrintTimerStarted(); }`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ class DGUSDisplay {`
`71`	`71`	`write(addr, static_cast<const void*>(&data), sizeof(T));`
`72`	`72`	`}`
`73`	`73`
`74`		`- // Until now I did not need to actively read from the display. That's why there is no ReadVariable`
	`74`	`+ // Until now I did not need to actively read from the display. That's why there is no readVariable`
`75`	`75`	`// (I extensively use the auto upload of the display)`
`76`	`76`
`77`	`77`	`// Read GUI and OS version from screen`
Original file line number	Diff line number	Diff line change
`@@ -281,7 +281,7 @@ void DGUSScreenHandler::configurationStoreRead(bool success) {`
`281`	`281`	`}`
`282`	`282`	`}`
`283`	`283`
`284`		`-void DGUSScreenHandler::playTone(const uint16_t frequency, const uint16_t duration) {`
	`284`	`+void DGUSScreenHandler::playTone(const uint16_t frequency, const uint16_t duration/=0/) {`
`285`	`285`	`if (WITHIN(frequency, 1, 255)) {`
`286`	`286`	`if (WITHIN(duration, 1, 255))`
`287`	`287`	`dgus.playSound((uint8_t)frequency, (uint8_t)duration);`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ namespace ExtUI {`
`59`	`59`	`void onMediaError() { TERN_(HAS_MEDIA, screen.sdCardError()); }`
`60`	`60`	`void onMediaRemoved() { TERN_(HAS_MEDIA, screen.sdCardRemoved()); }`
`61`	`61`
`62`		`- void onPlayTone(const uint16_t frequency, const uint16_t duration) {`
	`62`	`+ void onPlayTone(const uint16_t frequency, const uint16_t duration/=0/) {`
`63`	`63`	`screen.playTone(frequency, duration);`
`64`	`64`	`}`
`65`	`65`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ class DGUSDisplay {`
`74`	`74`	`write(addr, static_cast<const void*>(&data), sizeof(T));`
`75`	`75`	`}`
`76`	`76`
`77`		`- // Until now I did not need to actively read from the display. That's why there is no ReadVariable`
	`77`	`+ // Until now I did not need to actively read from the display. That's why there is no readVariable`
`78`	`78`	`// (I extensively use the auto upload of the display)`
`79`	`79`
`80`	`80`	`// Read GUI and OS version from screen`