From c12baf4c6dd20ffad01bad8b75493178b1c4e82c Mon Sep 17 00:00:00 2001 From: Jeff Kletsky Date: Wed, 14 Apr 2021 20:56:34 -0700 Subject: [PATCH] gui: Revise wording on after_flow_complete to "Shot complete" Change the default implementation of ::gui::notify::scale_event record_complete to be "Shot complete" for those skins that do not override it. Adjust documentation to reflect the change. Signed-Off-By: Jeff Kletsky --- de1plus/gui.tcl | 7 +++---- documentation/de1_app_core_shot_cycle_overview.md | 5 +++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/de1plus/gui.tcl b/de1plus/gui.tcl index dc4db4f0..b2a38953 100644 --- a/de1plus/gui.tcl +++ b/de1plus/gui.tcl @@ -3057,10 +3057,9 @@ namespace eval ::gui::notify { } record_complete { - # don't need to give an ENJOY message when the app already gives "stopped on volume, stopped on weight" messages just a few seconds earlier. - #set what [translate {Enjoy!}] - #borg toast $what - #say $what $::settings(sound_button_in) + set what [translate {Shot complete}] + borg toast $what + say $what $::settings(sound_button_in) } saw_stop { diff --git a/documentation/de1_app_core_shot_cycle_overview.md b/documentation/de1_app_core_shot_cycle_overview.md index 746fbdbe..c9837d8d 100644 --- a/documentation/de1_app_core_shot_cycle_overview.md +++ b/documentation/de1_app_core_shot_cycle_overview.md @@ -12,6 +12,7 @@ Suggestions, improvements, and contributions are welcome. # Revision History +* 2021-04-14 – Wording change on `after_shot_complete` default message * 2021-03-22 – Reflect code changes that removed previous scheduled tare * 2021-03-14 – Autotare threshold updated. Minor corrections and clarfications. * 2021-03-10 – Initial release @@ -280,7 +281,7 @@ It also changes the state utilities: ### After Flow Complete Countdown Begins -At this point, a timer is set for the `::de1::event::apply::after_flow_complete_callbacks` based on `$$::settings(after_flow_complete_delay)` +At this point, a timer is set for the `::de1::event::apply::after_flow_complete_callbacks` based on `$::settings(after_flow_complete_delay)` The purpose of this callback is primarily to delay events related to "shot done" (such as determination final drink weight or saving the completed shot record) long enough for everything to settle down. Although the ending phase *may* be long enough for this, it can be very short. This event will be fired a minimum of time later, but not before exiting the Espresso state. @@ -342,6 +343,6 @@ The GUI is notified that the shot is complete directly so that it can message th ::gui::notify::scale_event record_complete ``` -*The default implementation is to raise a toast and speak "Enjoy!"* +*The default implementation is to raise a toast and speak "Shot complete"* For reference, detection of the scale data being recorded can be done with `::device::scale::history::is_recording` \ No newline at end of file