Add deeper sleep support (talonhub#1813)

Add a tag for enabling sleep with a longer wakeup command

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Nicholas Riley <[email protected]>

Author: 3 people

core/modes/deep_sleep.py

@@ -0,0 +1,41 @@
+from talon import Context, Module, actions
+
+mod = Module()
+mod.tag(
+    "deep_sleep",
+    desc="Tag for enabling deep sleep, requiring a longer wakeup command (defined in `sleep_mode_deep.talon`)",
+)
+
+ctx = Context()
+
+
+@mod.action_class
+class Actions:
+    def deep_sleep_enable():
+        """Enable deep sleep.
+
+        Deep sleep requires a longer wakeup command to exit sleep
+        mode, helping prevent unintended wakeups from conversations,
+        meetings, listening to videos, etc.
+
+        Instead of invoking this action directly, consider enabling
+        the `user.deep_sleep` tag in applications where unwanted
+        wakeups are more likely or problematic, such as meeting
+        apps. With this tag active, any sleep command triggers deep
+        sleep.
+
+        You can also manually activate deep sleep by defining a custom
+        voice command using this action.
+
+        Note: If the user.deep_sleep_disable action is not used to
+        wake up from deep sleep, then the deep sleep tag will stay
+        active.
+
+        """
+        ctx.tags = ["user.deep_sleep"]
+        actions.speech.disable()
+
+    def deep_sleep_disable():
+        """Disable deep sleep"""
+        ctx.tags = []
+        actions.speech.enable()

core/modes/modes_not_dragon.talon

@@ -15,15 +15,6 @@ not speech.engine: dragon
 # because it's part of the rule definition, but "hey bob" will be ignored, because
 # we don't do anything with the <phrase> in the body of the command.
 
-^talon wake [<phrase>]$: speech.enable()
-
-# We define this *only* if the speech engine isn't Dragon, because if you're using Dragon,
-# "wake up" is used to specifically control Dragon, and not affect Talon.
-#
-# It's a useful and well known command, though, so if you're using any other speech
-# engine, this controls Talon.
-^(wake up)+$: speech.enable()
-
 # We define this *only* if the speech engine isn't Dragon, because if you're using Dragon,
 # "go to sleep" is used to specifically control Dragon, and not affect Talon.
 #

core/modes/sleep_mode.talon

@@ -7,30 +7,3 @@ settings():
     user.mouse_enable_pop_click = 0
     # Stop mouse scroll down using hiss noise
     user.mouse_enable_hiss_scroll = false
-
-#================================================================================
-# Commands to wake Talon
-#================================================================================
-
-# Note: these have repeaters on them (+) to work around an issue where, in sleep mode,
-# you can get into a situation where these commands are difficult to trigger.
-
-# These commands are fully anchored (^ and $), which means that there must be
-# silence before and after saying them in order for them to recognize (this reduces
-# false positives during normal sleep mode, normally a good thing).
-
-# However, ignored background speech during sleep mode also counts as an utterance.
-
-# Thus, if you say "blah blah blah talon wake", these won't trigger, because "blah
-# blah blah" was part of the same utterance. You have to say "blah blah blah" <pause,
-# wait for speech timeout>, "talon wake" <pause, wait for speech timeout>.
-
-# Sometimes people would forget the second pause, notice things weren't working, and
-# say "talon wake" over and over again before the speech timeout ever gets hit, which
-# means that these won't recognize. The (+) handles this case, so if you say
-# <pause> "talon wake talon wake" <pause>, it'll still work.
-
-^(welcome back)+$:
-    user.mouse_wake()
-    user.history_enable()
-    user.talon_mode()

core/modes/sleep_mode_deep.talon

@@ -0,0 +1,5 @@
+mode: sleep
+tag: user.deep_sleep
+-
+
+^wake up and listen$: user.deep_sleep_disable()

core/modes/modes_dragon.talon renamed to core/modes/sleep_mode_dragon.talon

@@ -13,7 +13,6 @@ speech.engine: dragon
 # because it's part of the rule definition, but "hey bob" will be ignored, because
 # we don't do anything with the <phrase> in the body of the command.
 ^talon sleep [<phrase>]$: speech.disable()
-^talon wake [<phrase>]$: speech.enable()
 
 ^sleep all [<phrase>]$:
     user.switcher_hide_running()

core/modes/sleep_mode_not_dragon.talon

@@ -0,0 +1,14 @@
+mode: command
+mode: dictation
+mode: sleep
+not speech.engine: dragon
+not tag: user.deep_sleep
+-
+
+# We define this *only* if the speech engine isn't Dragon, because if you're using Dragon,
+# "wake up" is used to specifically control Dragon, and not affect Talon.
+#
+# It's a useful and well known command, though, so if you're using any other speech
+# engine, this controls Talon.
+
+^(wake up)+$: speech.enable()

core/modes/sleep_mode_wakeup.talon

@@ -0,0 +1,32 @@
+mode: sleep
+not tag: user.deep_sleep
+-
+
+#================================================================================
+# Commands to wake Talon
+#================================================================================
+
+# Note: these have repeaters on them (+) to work around an issue where, in sleep mode,
+# you can get into a situation where these commands are difficult to trigger.
+
+# These commands are fully anchored (^ and $), which means that there must be
+# silence before and after saying them in order for them to recognize (this reduces
+# false positives during normal sleep mode, normally a good thing).
+
+# However, ignored background speech during sleep mode also counts as an utterance.
+
+# Thus, if you say "blah blah blah talon wake", these won't trigger, because "blah
+# blah blah" was part of the same utterance. You have to say "blah blah blah" <pause,
+# wait for speech timeout>, "talon wake" <pause, wait for speech timeout>.
+
+# Sometimes people would forget the second pause, notice things weren't working, and
+# say "talon wake" over and over again before the speech timeout ever gets hit, which
+# means that these won't recognize. The (+) handles this case, so if you say
+# <pause> "talon wake talon wake" <pause>, it'll still work.
+
+^(welcome back)+$:
+    user.mouse_wake()
+    user.history_enable()
+    user.talon_mode()
+
+^talon wake [<phrase>]$: speech.enable()