Skip to content

Commit

Permalink
gui: Revise wording on after_flow_complete to "Shot complete"
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
jeffsf authored and Mimoja committed Apr 15, 2021
1 parent c531626 commit c12baf4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
7 changes: 3 additions & 4 deletions de1plus/gui.tcl
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 3 additions & 2 deletions documentation/de1_app_core_shot_cycle_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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`

0 comments on commit c12baf4

Please sign in to comment.