Add support for timers in Assist Microphone (#3892)

* Bump Wyoming Satellite version to 1.3.0

Bump to add support for timers via new wyoming cli arguments

* Add timer_wav to the config.yaml

* Add --timer-finished-wav-repeat flag

* Add timer repeat and delay config fields

* Adjust timer_finished.wav filename

* Config parameter adjustment

* Add timer_finished.wav

* adjust timer_finished_wav parameter usage

* fixing schema parameter

* Bump addon version to 1.3.0

* Update Assist Microphone Documentation

Add docs for new timer configuration options

* Update CHANGELOG.md

* Add field description translations for new arguments

assist_microphone/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.3.0
+
+- Update to wyoming-satellite 1.3.0 to get support for timers
+- Added configuration options for setting timer sound, repetitions and delay
+
 ## 1.2.0
 
 - Update to wyoming-satellite 1.2.0

assist_microphone/DOCS.md

@@ -24,6 +24,18 @@ Path to WAV file to play when wake word is detected (empty to disable, default i
 
 Path to WAV file to play when voice command is finished (empty to disable, default is `/usr/src/sounds/done.wav`).
 
+### Option: `timer_finished_wav`
+
+Path to WAV file to play when timer is finished (empty to disable, default is `/usr/src/sounds/timer_finished.wav`).
+
+### Option: `timer_repeat_count`
+
+Number of times to repeat `timer_finished_wav` (default is 3).
+
+### Option: `timer_repeat_delay`
+
+Delay before repeating `timer_finished_wav`, in seconds (default is 0.75).
+
 ### Option: `noise_suppression`
 
 Noise suppression level (0 is disabled, 4 is max). Disabled by default.

assist_microphone/build.yaml

@@ -6,4 +6,4 @@ codenotary:
   signer: [email protected]
   base_image: [email protected]
 args:
-  WYOMING_SATELLITE_VERSION: 1.2.0
+  WYOMING_SATELLITE_VERSION: 1.3.0

assist_microphone/config.yaml

@@ -1,5 +1,5 @@
 ---
-version: 1.2.0
+version: 1.3.0
 slug: assist_microphone
 name: Assist Microphone
 description: Use Assist with local microphone
@@ -16,6 +16,9 @@ map:
 options:
   awake_wav: "/usr/src/sounds/awake.wav"
   done_wav: "/usr/src/sounds/done.wav"
+  timer_finished_wav: "/usr/src/sounds/timer_finished.wav"
+  timer_repeat_count: 3
+  timer_repeat_delay: 0.75
   sound_enabled: true
   noise_suppression: 0
   auto_gain: 0
@@ -25,6 +28,9 @@ options:
 schema:
   awake_wav: str
   done_wav: str
+  timer_finished_wav: str
+  timer_repeat_count: int
+  timer_repeat_delay: float
   sound_enabled: bool
   noise_suppression: int
   auto_gain: int

assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/run

@@ -20,6 +20,8 @@ exec python3 -m wyoming_satellite \
     --snd-command-rate 16000 \
     --awake-wav "$(bashio::config 'awake_wav')" \
     --done-wav "$(bashio::config 'done_wav')" \
+    --timer-finished-wav "$(bashio::config 'timer_finished_wav')" \
+    --timer-finished-wav-repeat "$(bashio::config 'timer_repeat_count')" "$(bashio::config 'timer_repeat_delay')" \
     --mic-volume-multiplier "$(bashio::config 'mic_volume_multiplier')" \
     --snd-volume-multiplier "$(bashio::config 'sound_volume_multiplier')" \
     --mic-auto-gain "$(bashio::config 'auto_gain')" \

assist_microphone/translations/en.yaml

@@ -9,6 +9,19 @@ configuration:
     description: >-
       Path to WAV file to play when voice command is finished (empty to
       disable).
+  timer_finished_wav:
+    name: Timer Finished WAV
+    description: >-
+      Path to WAV file to play when timer is finished (empty to disable,
+      default is /usr/src/sounds/timer_finished.wav).
+  timer_repeat_count:
+    name: Timer Finished WAV Repetition Count
+    description: >-
+      Number of times to repeat timer_finished_wav (default is 3).
+  timer_repeat_delay:
+    name: Timer Repetition Delay
+    description: >-
+      Delay before repeating timer_finished_wav, in seconds (default is 0.75).
   noise_suppression:
     name: Noise suppression
     description: >-