This release is a pre-release and may not be stable for production use.
OVOS GUI MessageBus
ovos-gui is the GUI messagebus service for ovos-core. It manages GUI state and implements the GUI protocol.
GUI clients (the applications that draw the GUI) connect to this service over a websocket.
Configuration
Configure the service under mycroft.conf.
{
"gui": {
// Override: SYSTEM (set by specific enclosures)
// Uncomment or add "idle_display_skill" to set the initial homescreen
// "idle_display_skill": "skill-ovos-homescreen.openvoiceos",
// Extensions are plugins that add GUI platform support for specific devices.
// For example, set extension to "ovos-gui-plugin-shell-companion" if you use ovos-shell.
"extension": "generic",
// The default generic extension can provide homescreen functionality if enabled.
"generic": {
"homescreen_supported": false
},
// Optionally set a default QT version for connected clients that do not report one.
// NOTE: currently only QT5 clients exist
"default_qt_version": 5
},
// The GUI messagebus websocket. One port is created per connected GUI.
"gui_websocket": {
"host": "0.0.0.0",
"base_port": 18181,
"route": "/gui",
"ssl": false
}
}
Plugins
Plugins add platform-specific GUI functionality, such as showing a homescreen or closing a window.
You usually do not need any of these plugins unless a GUI client application tells you to install one.
- OpenVoiceOS/ovos-gui-plugin-shell-companion
- OpenVoiceOS/ovos-gui-plugin-mobile
- OpenVoiceOS/ovos-gui-plugin-plasmoid
- OpenVoiceOS/ovos-gui-plugin-bigscreen
Related projects
- OpenVoiceOS/ovos-core — the assistant runtime that this service runs alongside.
- OpenVoiceOS/ovos-gui-api-client — a Python client library for this service.
- OpenVoiceOS/ovos-shell — a reference GUI client that connects to this service.
Limitations
Skills and other OVOS components populate GUI resource files under the local OVOS cache directory. GUI client applications must be able to reach these files.
This means a GUI client must run on the same machine as ovos-gui, or implement its own access to the resource files. Resolving page names to URIs is the responsibility of the client application.
TODO: a new repository will host the removed GUI file server, to serve resource files from the cache directory to client apps.
In a container setup, mount a shared volume between ovos-gui, the skills service, and the GUI client apps.
License
This project is licensed under the Apache License 2.0.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ovos_gui-1.5.0a1.tar.gz.
File metadata
- Download URL: ovos_gui-1.5.0a1.tar.gz
- Upload date:
- Size: 35.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a83f2502348dc2ea5077628d9888f5e4a87b6917f0191a5fdc8fe30ca89e3055
|
|
| MD5 |
072ef6d10ec310c202ca69140896930e
|
|
| BLAKE2b-256 |
f18a4e9cfc302a9ffd5242b5c772161c52db44099aa31f9fbc8e41073ee63fae
|
File details
Details for the file ovos_gui-1.5.0a1-py3-none-any.whl.
File metadata
- Download URL: ovos_gui-1.5.0a1-py3-none-any.whl
- Upload date:
- Size: 47.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ed20222c2541cd5cbd0c6feef370f2a4059beef40e2f721df5523b5378a8c191
|
|
| MD5 |
0c2644d6c1dafe978329339bd8ec05e2
|
|
| BLAKE2b-256 |
95f6be68460558a10406c49c64a03c4ff5cc01d33177f0da20accc853561051d
|
