Examples for configuring hotwords #76

timonvanhasselt · 2023-09-11T07:10:29Z

No description provided.

A first try to add some extra useful info I got from the OVOS forum (Matrix), that helped me using hotwords.

builderjer

There are a few typos and grammatical errors, that I am no good at fixing. I think some of the examples could be expanded upon. This is docs for new or casual users. They may not know what section they go in. Also maybe a link somewhere that describes what config file to be editing. https://openvoiceos.github.io/community-docs/config/

builderjer · 2023-09-11T12:45:42Z

docs/ht_ww.md

+
+  *	`“bus_event” : “mycroft.mic.mute"`
+
+* Use a hotkey; allows you to assign a keyboard shortcut (e.g., "ctrl+alt+h") for triggering the hotword manually. The ovos_ww_hotkeys module is         required forusing a hotkey.


Any time you mention a plugin, ovos_ww_hotkeys try and put a link to it

forusing should be for using.

I've checked the urls and typo.

builderjer · 2023-09-11T12:46:46Z

docs/ht_ww.md

-OVOS uses "wakewords" to activate the system.  This is what "hey Google" or "Alexa" is on proprietary devices.  By default, OVOS uses the WakeWord "hey Mycroft".
+OVOS uses "wakewords" to activate the system. This is what "hey Google" or "Alexa" is on proprietary devices. By default, OVOS uses the WakeWord "hey Mycroft".
+
+OVOS "hotwords" is the configuration section in `mycroft.conf` config  to specify what the WakeWord do.  Multiple "hotwords" can be used to do a variety of things from putting OVOS into active listening mode, a WakeWord like "hey Mycroft", to issuing a command such as "stop" or "wake up"


Grammar is not quite correct here, and in several other places.
I will refer @mikejgray to that though.

Suggestion:

In OVOS, a WakeWord is configured in the hotwords section of the user's mycroft.conf configuration (defaults to ~/.config/mycroft/mycroft.conf). Multiple "hotwords" can be configured at one time. They can trigger a variety of tasks, ranging from putting OVOS into active listening mode (the default for "hey Mycroft") to issuing a command such as "stop" or "wake up."

Thanks both! I tried to stay close to the original text and only add some extra info. I've followed your suggestion @mikejgray.

mikejgray

Great content and a welcome addition to the docs! I've made some grammatical suggestions and adjustments to syntax in config examples.

mikejgray · 2023-09-12T03:52:32Z

docs/ht_ww.md

-OVOS uses "wakewords" to activate the system.  This is what "hey Google" or "Alexa" is on proprietary devices.  By default, OVOS uses the WakeWord "hey Mycroft".
+OVOS uses "wakewords" to activate the system. This is what "hey Google" or "Alexa" is on proprietary devices. By default, OVOS uses the WakeWord "hey Mycroft".
+
+OVOS "hotwords" is the configuration section in `mycroft.conf` config  to specify what the WakeWord do.  Multiple "hotwords" can be used to do a variety of things from putting OVOS into active listening mode, a WakeWord like "hey Mycroft", to issuing a command such as "stop" or "wake up"


Suggestion:

In OVOS, a WakeWord is configured in the hotwords section of the user's mycroft.conf configuration (defaults to ~/.config/mycroft/mycroft.conf). Multiple "hotwords" can be configured at one time. They can trigger a variety of tasks, ranging from putting OVOS into active listening mode (the default for "hey Mycroft") to issuing a command such as "stop" or "wake up."

mikejgray · 2023-09-12T03:54:23Z

docs/ht_ww.md

+
+Each hotword can do one or more of the following (with example configs):
+* trigger listening, also called a wake_word (default option)
+  * `“Listen” : “True”`


This isn't quite right. The quotes are the wrong Unicode characters and will cause the config file to fail to load. Also, you need a boolean value instead of a string. Finally, the key is case-sensitive.

"listen": true

Oof, that wat very sloppy of me... I've rechecked all the unicode characters and boolean values.

mikejgray · 2023-09-12T03:55:16Z

docs/ht_ww.md

+* play a sound (only or with other action), you can set a specific sound per hotword.
+  * `"sound": "snd/start_listening.wav"`


Consider mentioning that taking another action would require a plugin or skill to act on the bus message that is triggered by the WakeWord.

I think leaving out the part about other actions (instead of only playing a sound) completely is maybe more clear, because the other lines that follow the "sound" config make that more clear (imho).

@JarbasAl When I add the "utterance" config to the HotWord section AND "sound" to the hotword, the custom sound is not played.
So like this:

"hotwords": { "hotkey": { "module": "ovos_ww_hotkeys", "listen": false, "active": true, "hotkey": "space", "utterance": "what time is it?", "sound": "snd/acknowledge.mp3" } }

Is that a possible issue or by design?

mikejgray · 2023-09-12T03:55:35Z

docs/ht_ww.md

+* emit a utterance to open a skill directly (instead of listen), useful to open skills from others.
+  * `“utterance” : “What’s the time”` 
+  * `“listen” : “false”`


See previous note about quotes and booleans

mikejgray · 2023-09-12T03:56:30Z

docs/ht_ww.md

+  This example will start the date & time skill with the given utterance and not listen for a command.
+
+* emit a bus event directly to the messagebus, to for instance open a skill you developed yourself  (instead of listen / utterance), emit a message directly (microphone mute/unmute"
+  *	`“bus_event” : “custom message that you use in your own skill”`


Incorrect quote characters. Also, consider custom.message.that.you.use.in.your.own.skill to match the pattern bus messages uses.

mikejgray · 2023-09-12T03:56:33Z

docs/ht_ww.md

+
+     or
+
+  *	`“bus_event” : “mycroft.mic.mute"`


mikejgray · 2023-09-12T03:56:53Z

docs/ht_ww.md

+
+  *	`“bus_event” : “mycroft.mic.mute"`
+
+* Use a hotkey; allows you to assign a keyboard shortcut (e.g., "ctrl+alt+h") for triggering the hotword manually. The ovos_ww_hotkeys module is         required forusing a hotkey.


forusing should be for using.

mikejgray · 2023-09-12T03:57:23Z

docs/ht_ww.md

+* assign a language for STT per wake word
+  * `Example?`


This should have an example but I'm not sure what this syntax would be. Maybe @JarbasAl can chime in?

"stt_lang": "pt-pt" -> at STT stage then pt-pt will be requested instead of global lang

mikejgray · 2023-09-12T03:57:48Z

docs/ht_ww.md

+    // unless explicitly disabled under "hotwords" section with "active": false. This is usually not
+       desired unless you are looking to completely disable wake word usage
+    "wake_word": "hey mycroft",
+    "stand_up_word": "wake up"


Looking for @JarbasAl confirmation that this syntax works as a wake word

I agree, Jarbas should review this one because of what it is.

under the "listener" section you specify the default wake_word and stand_up_word

these will be automatically set active: true (unless you override it in the individual config of each word)

in single wake word mode you never set active flag in each definition, you only change this value. when using a backend for example this is the only thing that changes

This is a part I don't understand tbh, the difference between wake(up?)word and stand_up word as a hotword config.
So, I don't think my interpretation is helpful here, sorry. I've copied the comments text from the technical manual or the dinkum listener (If I recall correctly).

wake_word -> start listening, "hey mycroft"
stand_up_word -> come out of sleep mode , default to "wake up"

@JarbasAl So If I understand correctly:

Hey Mycroft is standard wake word (configured in listener). But if I would like to have 'Hey Ziggy', as an extra wake word, that triggers a certain action, then I define 'Hey Ziggy' as a hotword and set it to active.

I think a complete example config (of listener + hotword sections) with a standard WW and extra hotwords would help a lot! Then we can explain the config and what every hotword do... Like your snowboy/ "self destruct video", that was for me an eyeopener that this configs were possible at all! I know the video is old, but it would help 'simple' users as me a lot :)

mikejgray · 2023-09-12T03:58:22Z

docs/ht_ww.md

@@ -58,4 +102,23 @@ If enabling a wakeword, be sure to also set `"listen": true`.

 Multiple hotwords can be configured at the same time, even the same word with different plugins.  This allows for more accurate ones to be used before the less accurate, but only if the plugin is installed.

+
+### Example hotword config (keyboard wakeword)


Should be ## instead of ###, as this is not a sub-heading of "List of OVOS WakeWord Plugins"

Changes after review

timonvanhasselt added 2 commits September 10, 2023 22:26

Update ht_ww.md

d461674

A first try to add some extra useful info I got from the OVOS forum (Matrix), that helped me using hotwords.

Update ht_ww.md

6fc51b4

builderjer reviewed Sep 11, 2023

View reviewed changes

mikejgray requested changes Sep 12, 2023

View reviewed changes

Update ht_ww.md

de774a7

Changes after review

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Examples for configuring hotwords #76

Examples for configuring hotwords #76

timonvanhasselt commented Sep 11, 2023

builderjer left a comment

builderjer Sep 11, 2023

mikejgray Sep 12, 2023

timonvanhasselt Sep 12, 2023

builderjer Sep 11, 2023

mikejgray Sep 12, 2023

timonvanhasselt Sep 12, 2023

mikejgray left a comment

mikejgray Sep 12, 2023

mikejgray Sep 12, 2023

timonvanhasselt Sep 12, 2023

mikejgray Sep 12, 2023

timonvanhasselt Sep 12, 2023

timonvanhasselt Sep 12, 2023

mikejgray Sep 12, 2023

mikejgray Sep 12, 2023

mikejgray Sep 12, 2023

mikejgray Sep 12, 2023

mikejgray Sep 12, 2023

JarbasAl Sep 12, 2023

timonvanhasselt Sep 12, 2023

mikejgray Sep 12, 2023

builderjer Sep 12, 2023

JarbasAl Sep 12, 2023

timonvanhasselt Sep 12, 2023 •

edited

Loading

JarbasAl Sep 12, 2023

timonvanhasselt Sep 12, 2023 •

edited

Loading

mikejgray Sep 12, 2023


		* `“bus_event” : “mycroft.mic.mute"`

		* Use a hotkey; allows you to assign a keyboard shortcut (e.g., "ctrl+alt+h") for triggering the hotword manually. The ovos_ww_hotkeys module is required forusing a hotkey.

		* play a sound (only or with other action), you can set a specific sound per hotword.
		* `"sound": "snd/start_listening.wav"`

		@@ -58,4 +102,23 @@ If enabling a wakeword, be sure to also set `"listen": true`.

		Multiple hotwords can be configured at the same time, even the same word with different plugins. This allows for more accurate ones to be used before the less accurate, but only if the plugin is installed.


		### Example hotword config (keyboard wakeword)

Examples for configuring hotwords #76

Are you sure you want to change the base?

Examples for configuring hotwords #76

Conversation

timonvanhasselt commented Sep 11, 2023

builderjer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikejgray left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timonvanhasselt Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timonvanhasselt Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timonvanhasselt Sep 12, 2023 •

edited

Loading

timonvanhasselt Sep 12, 2023 •

edited

Loading