Skip to main content

ovos-core gui service daemon

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos-gui-1.1.0.tar.gz (25.1 kB view details)

Uploaded Source

Built Distribution

ovos_gui-1.1.0-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

Details for the file ovos-gui-1.1.0.tar.gz.

File metadata

  • Download URL: ovos-gui-1.1.0.tar.gz
  • Upload date:
  • Size: 25.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos-gui-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a8b5197392af54e8dfb3f34b98a5743927e64e3ed67e3397afb3058e0276d634
MD5 c0f8cce06b292cbd1451aeff9897c716
BLAKE2b-256 d9eae5d8ae226f7a253007a7d1a613e9be87a98b67446ba69c330de48228c750

See more details on using hashes here.

File details

Details for the file ovos_gui-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: ovos_gui-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 36.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos_gui-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 476cd5b804439e08b1776773fd5cccaa2493eed3f0b93669d4e3c008647fc124
MD5 385190e67b23eff14280e9b4738cbcb2
BLAKE2b-256 2c8fdadce0f77e42f8e88278c014e295065bcf1d42da484e4eaa615cc35e010c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page