OVOS Shell companion

provides various bus APIs that integrate with ovos-shell

- color scheme manager
- notifications widgets
- configuration provider  (settings UI)
- brightness control  (night mode etc)

Features

{
  "gui": {
     "ovos-gui-plugin-shell-companion": {
       "sunrise_time": "auto",
       "sunset_time": "auto",
       "default_brightness": 100,
       "night_default_brightness": 70,
       "low_brightness": 20,
       "auto_dim_seconds": 60,
       "auto_dim": false,
       "auto_nightmode": false
     }
  }
}

Night mode

night mode will perform actions based on sunset/sunrise times

the homescreen changes to a simple clock with white text on a black background.
default brightness is reduced.
auto-dim is enabled

sunrise_time and sunset_time will be automatically calculated based on location if set to "auto", specific times can be explicitly set with the format "HH:MM", eg. if you are an early riser you may want "sunrise_time": "05:30"

brightness level during nighttime can be set via "night_default_brightness"

Auto Dim

auto-dim will lower the screen brightness after 60 seconds of inactivity, until the user interacts with the GUI or talks to the OVOS device

brightness level when idle can be set via "low_brightness"

auto-dim can be enabled at all times by setting "auto_dim": true in your config

DEPRECATION WARNING

in ovos-core version 0.0.7 the bus apis provided by this repo used to be several individual PHAL plugins

the following packages have been deprecated in favor of this repo:

ovos-PHAL-plugin-dashboard <- DEPRECATED, community maintained, no official replacement, removed from ovos-shell
ovos-PHAL-plugin-configuration-provider <- now part of this repo
ovos-PHAL-plugin-notification-widgets <- now part of this repo
ovos-PHAL-plugin-brightness-control-rpi <- now part of this repo
ovos-PHAL-plugin-color-scheme-manager <- now part of this repo

Metadata

Release files for ovos-gui-plugin-shell-companion 1.0.6

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-plugin-shell-companion 1.0.6
File	Size	Uploaded
ovos_gui_plugin_shell_companion-1.0.6.tar.gz	85.7 kB	Nov 5, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-gui-plugin-shell-companion 1.0.6
File	Interpreter	ABI	Platform	Reset
ovos_gui_plugin_shell_companion-1.0.6-py3-none-any.whl 158.8 kB Nov 5, 2025	Python 3	none	any	Details

Total release size: 244.5 kB

Release files / ovos_gui_plugin_shell_companion-1.0.6.tar.gz

Download URL	ovos_gui_plugin_shell_companion-1.0.6.tar.gz
Size	85.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`5a88637bac662be05fe7142129e87b4dfcb4f0e561923a2968ca6d6a5385fe8d`
BLAKE2b-256 checksum How to use checksums	`b840221f088c27fcedd10eeb0e51185215d58c83010ed941b99ef8d54cba20c4`
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_plugin_shell_companion-1.0.6-py3-none-any.whl

Download URL	ovos_gui_plugin_shell_companion-1.0.6-py3-none-any.whl
Size	158.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3bfd72bcae50af6d3152b3e5f963a2f9dd8c42bd11087c9b0214a444c284a445`
BLAKE2b-256 checksum How to use checksums	`85b7a094b77da71cf9cb7ff5d139e839c9eff66cafe52a8cf88fae0361125cbb`
Upload date	Nov 5, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.9.25`