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
Metadata
2 maintainers
Release files for ovos-gui 1.5.2a1
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_gui-1.5.2a1.tar.gz | 35.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_gui-1.5.2a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 83.4 kB
Release files / ovos_gui-1.5.2a1.tar.gz
| Download URL | ovos_gui-1.5.2a1.tar.gz |
|---|---|
| Size | 35.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
da15b0d3ae71c15ad6a5763c756fc62ae03f427de41294fae130bf07c0c38438
|
|
BLAKE2b-256 checksum How to use checksums |
7866b53d8cba459512e79ffbdfbb8adb31c7228e2a6ba3d4c173ca17f3a224af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ovos_gui-1.5.2a1-py3-none-any.whl
| Download URL | ovos_gui-1.5.2a1-py3-none-any.whl |
|---|---|
| Size | 47.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
10069ac91bc4bca5d94de927ab03d2dcd03942ed42399e0f731eaa68b30374d4
|
|
BLAKE2b-256 checksum How to use checksums |
f1d3f6e3e5b8e75e703d248a987fa2317be490d83ea9bdba486d0d77bbc5d857
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
