From e68b4075d449723834fbfccf8e839856293b0757 Mon Sep 17 00:00:00 2001 From: miro Date: Fri, 16 Aug 2024 14:30:20 +0100 Subject: [PATCH] readme --- README.md | 39 ++++++++++++++++++++++++++++++++++----- 1 file changed, 34 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b0ad071..8c7db57 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,41 @@ provides various bus APIs that integrate with ovos-shell - brightness control (night mode etc) -these used to be several individual plugins but they all are ovos-shell specific integrations and ovos-shell requires all of them, so they have been unified +## Features +```javascript +{ + "gui": { + "ovos-gui-plugin-shell-companion": { + "auto_dim": false, + "auto_nightmode": false + } + } +} +``` + +### AutoDim + +autodim will lower the screen brightness after 60 seconds of inactivity, until the user interacts with the GUI or talks to the OVOS device + +### Nightmode + +nightmode will perform actions based on sunset/sunrise times + +currently only the homescreen changes to a simple clock with white text on black background + +TODO, spec nighttime actions: +- lower volume +- set max brightness +- enable autodim + +## 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: - https://github.com/OpenVoiceOS/ovos-PHAL-plugin-dashboard <- DEPRECATED, community maintained, no official replacement, [removed from ovos-shell](https://github.com/OpenVoiceOS/ovos-gui/pull/10) -- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-configuration-provider -- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-notification-widgets -- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-brightness-control-rpi -- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-color-scheme-manager +- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-configuration-provider <- now part of this repo +- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-notification-widgets <- now part of this repo +- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-brightness-control-rpi <- now part of this repo +- https://github.com/OpenVoiceOS/ovos-PHAL-plugin-color-scheme-manager <- now part of this repo