From 0e26801f6d2be553d1b2c9c677ac50a444ba8d3c Mon Sep 17 00:00:00 2001 From: Aditya Mehra Date: Sun, 16 Oct 2022 09:11:20 +1030 Subject: [PATCH] Update README --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb9f006..061e64b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ # OVOS PHAL BRIGHTNESS CONTROL PLUGIN FOR RPI +This plugin provides a brightness control interface for the Raspberry PI, it supports DSI and **HDMI screens + +** HDMI Screens: Screens supported and detected by DDCUTILS only + +# Requirements - Requires ddcutils for HDMI: https://github.com/rockowitz/ddcutil (install location: "/usr/bin/ddcutil") -- Requires vcgencmd for DSI: https://github.com/raspberrypi/userland (install location: "/opt/vc/bin/vcgencmd") \ No newline at end of file +- Requires vcgencmd for DSI: https://github.com/raspberrypi/userland (install location: "/opt/vc/bin/vcgencmd") + +# Install + +`pip install ovos-PHAL-plugin-brightness-control-rpi` + +# Event Details: + +##### Brightness GET and Brightness SET + +Plugin provides methods to set and get brightness based on the detected screen type method. + +```python + self.bus.on("phal.brightness.control.get", self.query_current_brightness) + self.bus.on("phal.brightness.control.set", self.set_brightness_from_bus) +``` + +##### Auto Dim and Nightmode + +Plugin provides auto dim and nightmode activation and deactivation. + +```python + self.bus.on("speaker.extension.display.auto.dim.changed", self.is_auto_dim_enabled) + self.bus.on("speaker.extension.display.auto.nightmode.changed", self.is_auto_night_mode_enabled) +```