OVOS GUI MessageBus

GUI messagebus service, manages GUI state and implements the gui protocol

GUI clients (the application that actually draws the GUI) connect to this service

Configuration

under mycroft.conf

{
  "gui": {
    // Override: SYSTEM (set by specific enclosures)
    // Uncomment or add "idle_display_skill" to set initial homescreen
    // "idle_display_skill": "skill-ovos-homescreen.openvoiceos",

    // Extensions are plugins that provide additional GUI platform support for specific devices
    // eg, if using ovos-shell you should set extension to "ovos-gui-plugin-shell-companion"
    "extension": "generic",

    // Default generic extension can provide homescreen functionality if enabled
    "generic": {
        "homescreen_supported": false
    },
    
    // Optionally specify a default qt version for connected clients that don't report it
    // NOTE: currently only QT5 clients exist
    "default_qt_version": 5
  },
  
  // The GUI messagebus websocket.  Once port is created per connected GUI
  "gui_websocket": {
    "host": "0.0.0.0",
    "base_port": 18181,
    "route": "/gui",
    "ssl": false
  }
}

Plugins

plugins provide platform specific GUI functionality, such as determining when to show a homescreen or close a window

you should usually not need any of these unless instructed to install it from a GUI client application

Limitations

gui resources files are populated under ~/.cache/mycrot/ovos-gui by skills and other OVOS components and are expectd to be accessible by GUI client applications

This means GUI clients are expected to be running under the same machine or implement their own access to the resource files (resolving page names to uris is the client app responsibility)

TODO: new repository with the removed GUI file server, serve files from ~/.cache/mycrot/ovos-gui to be handled by client apps

In case of containers a shared volume should be mounted between ovos-gui, skills and gui client apps

Metadata

Release files for ovos-gui 1.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ovos-gui 1.3.4
File	Size	Uploaded
ovos_gui-1.3.4.tar.gz	35.9 kB	Nov 5, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-gui 1.3.4
File	Interpreter	ABI	Platform	Reset
ovos_gui-1.3.4-py3-none-any.whl 47.1 kB Nov 5, 2025	Python 3	none	any	Details

Total release size: 83.0 kB

Release files / ovos_gui-1.3.4.tar.gz

Download URL	ovos_gui-1.3.4.tar.gz
Size	35.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`f1a4214cb4b1adf4dcaecd875bad161937b90e40c1501d61adf0fec3d91c9a77`
BLAKE2b-256 checksum How to use checksums	`dfd7aae9af699da0e23047b58d480baf37f159dc7d14740bf7cc0e6a4b9c8ff1`
Upload date	Nov 5, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.9.25`

Release files / ovos_gui-1.3.4-py3-none-any.whl

Download URL	ovos_gui-1.3.4-py3-none-any.whl
Size	47.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7272a2fb4e4e6ee7f07673df6b3b54fbd51cc5c8c24fb44016f5703bccc578f1`
BLAKE2b-256 checksum How to use checksums	`8c4b4ca834fb02427a137fb21e006cefeea6e100ccbf71e3eed780b2546c85a1`
Upload date	Nov 5, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.9.25`