This release is a pre-release and may not be stable for production use.
GGWave audio plugin
plugin for https://github.com/ggerganov/ggwave
Emit audio QR codes to be handled by this plugin
Interact with this plugin from your browser, including WiFi setup
The companion skill OpenVoiceOS/ovos-skill-ggwave allows you to enable/disable this plugin by voice
Skill stores support installing skills via GGWave:
"skills": {
"installer": {
"allow_pip": true,
"allow_alphas": true,
"break_system_packages": false
}
}
TIP Allow ovos-core to install python packages, otherwise the install commands from this plugin will error out
Install
pip install ovos-audio-transformer-plugin-ggwave
ggwave fails to install on python 3.11, you can use the wheel from here https://whl.smartgic.io/ , plugin install should then work
Listener Plugin
To have this plugin loaded by dinkum-listener, enable it in mycroft.conf
WARNING currently not recommended, see bug report in dinkum-listener
"listener": {
"audio_transformers": {
"ovos-audio-transformer-plugin-ggwave": {
"start_enabled": true,
"listen_timeout": 300
}
}
}
listen_timeout (seconds, default 300) auto-disables the listener after it
has been enabled over the bus with ovos.ggwave.enable, so a stray or
forgotten enable does not leave data-over-sound listening on forever. This is
a security default: an enabled listener can trigger opcodes such as BUS:,
PIP:, and GHS: (install a skill from a GitHub URL) for anyone in earshot.
Set it to 0 (or a negative number) to disable this behavior and listen
indefinitely once enabled. It has no effect on start_enabled: enabling the
listener via config is an explicit operator decision to run always-on, and
does not arm the timer.
Standalone
You can also run the plugin in standalone mode, in it's own process or docker container
Launch with the console entrypoint
ovos-ggwave-listener
Valid Audio Data
this repo provides a test interface via github pages
you can also test your own payloads via https://ggwave-js.ggerganov.com/
Wifi setup
emit a message setting the wifi SSID
SSID:123456
after the SSID is set, emit a message setting the wifi password
PSWD:123456
if password is empty then it is assumed to be an open network
PSWD:
once password is received a bus message is sent for ovos-PHAL-plugin-network-manager to handle
Install a github skill
install a skill from a github url
GHS:https://github.com/OpenVoiceOS/skill-ovos-icanhazdadjokes
Install a python package
install any package from pypi
PIP:skill-wikipedia-for-humans
Utterance
inject an utterance in the messagebus like if the user spoke it to the microphone
UTT:hello cruel world
Speak
make a OVOS device speak
SPEAK:hello world
Bus
inject a simple message in the messagebus
BUS:recognizer_loop:sleep
Json
inject a serialized message in the messagebus
JSON:{"type": "speak", "data": {"utterance": "hello"}, "context": {}}
Release files for ovos-audio-transformer-plugin-ggwave 1.1.0a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ovos_audio_transformer_plugin_ggwave-1.1.0a1.tar.gz | 12.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_audio_transformer_plugin_ggwave-1.1.0a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.6 kB
Release files / ovos_audio_transformer_plugin_ggwave-1.1.0a1.tar.gz
| Download URL | ovos_audio_transformer_plugin_ggwave-1.1.0a1.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c26dc95ad02fe96a67b9f48fc0842ee3e90f3000e53a453b66d83a424b370b88
|
|
BLAKE2b-256 checksum How to use checksums |
c73e214226611f1994cc7a336a3420392804ae9395a2ff3a20e2e8699aac4dcc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ovos_audio_transformer_plugin_ggwave-1.1.0a1-py3-none-any.whl
| Download URL | ovos_audio_transformer_plugin_ggwave-1.1.0a1-py3-none-any.whl |
|---|---|
| Size | 11.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb01787fb08e8646739b350b322355813c74404e6e3c65df26dec6a349db26e6
|
|
BLAKE2b-256 checksum How to use checksums |
a3c396f0c39f7966ebde5a476c7f73543028075d6479a07503b17583dbc788ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|