mirror/bazzite
1
0
Fork 0
mirror of https://github.com/ublue-os/bazzite.git synced 2025-02-22 03:40:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add adaptive brightness script for handhelds other than the deck. Default disabled (Thanks @corando98)

Browse Source
This commit is contained in:
Kyle Gospodnetich 2024-07-10 16:58:04 -07:00
parent 88c2b657ad
commit 996d161bfb
1 changed files with 437 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

437
system_files/deck/shared/usr/libexec/adaptive_brightness.py Executable file
View File

@ -0,0 +1,437 @@
#!/usr/bin/env python3
"""
MIT License
Copyright (c) 2023 Diego C. Garcia
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
LtChipotle's Adaptive Brightness Algorithm
==========================================
Improved version.
Modify the following variables to adjust the algorithm:
User variables:
- sensitivity_factor: Adjusts how sensitive the algorithm is to changes in light, higher values = steeper curve
- min_brigthness_level: Adjusts the minimum brightness level, higher values = brighter minimum brightness
- step: Step size to adjust brightness by
- pause: Pause brightness adjustments
- silent: Silence all logging
To adjust the algorithm to your liking play with:
- sensitivity_factor (higher values = steeper curve) This value shrinks/grows the curve. (Values under 1, make the curve flatter and also limit the max brightness, use sensor shift instead)
- min_brightness_level (higher values = brighter minimum brightness) This value shifts the curve up/down.
- step (higher values = faster adjustments) This value controls how fast the brightness changes. (resolution)
- sensor_shift: This value shifts the curve left/right.(This might be better to adjust rather than the sensitivity factor)
Some profiles, which are not implemented yet, but can be used as a reference:
Profile: reading
Configuration Without Shift: {'sensitivity_factor': 0.8, 'min_brightness_level': 100, 'step': 50}
Suggested Sensor Shift Range: 0 to 100
Profile: day
Configuration Without Shift: {'sensitivity_factor': 1.5, 'min_brightness_level': 200, 'step': 100}
Suggested Sensor Shift Range: 150 to 250
Profile: evening
Configuration Without Shift: {'sensitivity_factor': 1.2, 'min_brightness_level': 50, 'step': 50}
Suggested Sensor Shift Range: 100 to 200
Profile: movie
Configuration Without Shift: {'sensitivity_factor': 0.5, 'min_brightness_level': 80, 'step': 20}
Suggested Sensor Shift Range: 200 to 300
Profile: night
Configuration Without Shift: {'sensitivity_factor': 0.3, 'min_brightness_level': 10, 'step': 30}
Suggested Sensor Shift Range: 50 to 150
Default: {sensitivity_factor': 1.0, 'min_brightness_level': 150, 'step': 50, 'sensor_shift': 150}
Sensitivity Factor: 1.0
This represents a moderate sensitivity to ambient light changes. The sensitivity factor determines how aggressively the algorithm responds to changes in the sensor's light readings.
Minimum Brightness Level: 150
This sets the lowest brightness level that the screen will adjust to. A value of 150 ensures that the screen remains visible and comfortable to view in low-light conditions, while not being overly bright in darker environments.
Step: 50
This value represents the increment or decrement step size for brightness adjustments. A step size of 50 strikes a balance between smooth transitions (avoiding abrupt changes in brightness) and timely responsiveness to changes in ambient light.
Sensor Shift: 150
The sensor shift value of 150 effectively shifts the brightness adjustment curve to the right. This means that the algorithm will start adjusting the brightness at higher sensor values, helping to avoid unnecessary adjustments due to minor fluctuations in light, which is particularly useful during varying light conditions throughout the day.
Developer only variables: (Use these only if you know what you're doing)
- num_readings: Number of sensor readings to average over
- max_sensor_value: Maximum sensor value, used to scale the sensor readings
- backlight_device: Backlight device name, used to locate the brightness file
- max_backlight_value: Maximum brightness value, used to cap the brightness
Example systemd service file: (Replace /path/to/ with the actual path to the script)
location example '/etc/systemd/system/adaptive_brightness.service'
'''
[Unit]
Description=Adaptive Brightness Service
After=network.target
[Service]
Type=simple
ExecStart=/path/to/adaptive_brightness.py start --min_brightness_level 400 --sensitivity_factor 1.0
ExecStop=/path/to/adaptive_brightness.py pause
ExecReload=/path/to/adaptive_brightness.py resume
User=your_username
Restart=on-failure
RestartSec=5s
[Install]
WantedBy=multi-user.target
'''
Then run the following commands:
sudo systemctl daemon-reload
sudo systemctl enable --now adaptive-brightness.service
sudo systemctl stop adaptive-brightness.service # This will run the pause subcommand
sudo systemctl start adaptive-brightness.service # This will run the start subcommand
sudo systemctl reload adaptie-brightness.service # This will run the resume subcommand
Sysfs control files:
/tmp/adaptive_brightness_pause.flag: Pause flag file, if this file exists, the service will pause brightness adjustments.
example: touch /tmp/adaptive_brightness_pause.flag # This will pause brightness adjustments
rm /tmp/adaptive_brightness_pause.flag # This will resume brightness adjustments
"""
# Constant for pause flag file
PAUSE_FLAG_FILE_PATH = '/tmp/adaptive_brightness_pause.flag'
CONTROL_FILE_PATH = '/tmp/adaptive_brightness_control.txt'
def check_for_commands():
try:
with open(CONTROL_FILE_PATH, 'r') as file:
command = file.read().strip()
os.remove(CONTROL_FILE_PATH) # Clear the command after reading
return command
except FileNotFoundError:
return None
# Constants for stability detection\
# This is delta value for the moving average to be considered stable, if the delta is within this value for STABILITY_DURATION amount of time, the cooldown will be increased to reduce constant brightness changes, flickering, etc. This also prevents the brightness from changing too quickly, and applies hysterisis.
STABILITY_THRESHOLD = 5
# The amount of time the moving average has to be stable for before the cooldown is increased.
STABILITY_DURATION = 60
# The value of STABILITY_DURATION set to 60 indicates the duration (in seconds) the moving average has to remain stable within the STABILITY_THRESHOLD before the cooldown period is increased. This is separate from the maximum cooldown period, which is the longest delay between subsequent brightness adjustments when the moving average is stable.
import os
import sys
import logging
import time
from time import sleep
from math import log
from threading import Lock
import argparse
# Configure logging
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
def calculate_brightness_from_sensor(sensor_value, max_sensor_value=2752, sensitivity_factor=1.0, min_brightness_level=400, max_brightness_level=2752, sensor_shift=0):
logging.debug(f"Received sensor value: {sensor_value}, sensitivity_factor: {sensitivity_factor}, min_brightness_level: {min_brightness_level}, max_brightness_level: {max_brightness_level}, sensor_shift: {sensor_shift}")
# Adjust the sensor value based on the sensor shift
adjusted_sensor_value = max(sensor_value - sensor_shift, 0)
logging.debug(f"Adjusted sensor value: {adjusted_sensor_value}")
# If adjusted sensor value is very low, return the minimum brightness level
if adjusted_sensor_value <= 0:
logging.debug(f"Returning min_brightness_level: {min_brightness_level} due to low adjusted sensor value")
return min_brightness_level
# Calculate the logarithmic scaling
log_scale = log(1 + adjusted_sensor_value) / log(1 + max_sensor_value - sensor_shift)
# Apply sensitivity factor
log_scale *= sensitivity_factor
# Scale the adjusted value to the range between min_brightness_level and max_brightness_level
brightness_range = max_brightness_level - min_brightness_level
target_brightness = int(log_scale * brightness_range) + min_brightness_level
# Ensure the brightness does not exceed the max brightness level and is not below the min brightness level
final_brightness = max(min(target_brightness, max_brightness_level), min_brightness_level)
logging.debug(f"Calculated target brightness: {final_brightness}")
return final_brightness
def read_brightness(backlight_device):
brightness_path = f'/sys/class/backlight/{backlight_device}/brightness'
try:
with open(brightness_path, 'r') as file:
return int(file.read().strip())
except OSError as e:
logging.error(f"Failed to read brightness: {e}")
sys.exit(1)
def write_brightness(backlight_device, brightness, max_backlight_value=4095):
brightness_path = f'/sys/class/backlight/{backlight_device}/brightness'
brightness = max(0, min(brightness, max_backlight_value))
try:
with open(brightness_path, 'w') as file:
file.write(str(brightness))
except OSError as e:
logging.error(f"Failed to write brightness: {e}")
return False
return True
def adjust_display_brightness(sensor_reading, backlight_device, max_sensor_value=2752, max_backlight_value=4095, step=10, sensitivity_factor=1.0, min_brightness_level=10, sensor_shift=0):
logging.debug("Adjusting display brightness")
logging.debug(f"Min brightness: {min_brightness_level}")
target_brightness = calculate_brightness_from_sensor(sensor_reading, max_sensor_value, sensitivity_factor, min_brightness_level, max_backlight_value, sensor_shift)
logging.debug(f"Target brightness: {target_brightness}")
current_brightness = read_brightness(backlight_device)
logging.debug(f"Current brightness: {current_brightness}")
step_value = step if target_brightness > current_brightness else -step
new_brightness = current_brightness
# Smaller sleep time for quicker adjustments or larger for smoother adjustments
adjustment_interval = 0.05 if step > 50 else 0.1
while abs(target_brightness - new_brightness) >= step:
new_brightness += step_value
if not write_brightness(backlight_device, new_brightness, max_backlight_value):
break
logging.debug(f"Adjusting brightness: {new_brightness}")
sleep(adjustment_interval) #smoothen transition
if not write_brightness(backlight_device, target_brightness, max_backlight_value):
logging.error("Failed to set brightness")
else:
logging.debug(f"Brightness adjusted to: {target_brightness}")
def locate_als_device():
iio_path = '/sys/bus/iio/devices/'
try:
for device_dir in os.listdir(iio_path):
if device_dir.startswith('iio:device'):
device_name_path = os.path.join(iio_path, device_dir, 'name')
with open(device_name_path, 'r') as file:
if file.read().strip() == 'als':
logging.debug(f"Found ALS device: {device_dir}")
return device_dir
except OSError as e:
logging.error(f"Failed to locate ALS device: {e}")
logging.error('ALS device not found')
sys.exit(1)
def locate_backlight_device():
backlight_base_path = '/sys/class/backlight/'
try:
devices = os.listdir(backlight_base_path)
if devices:
logging.debug(f"Found backlight devices: {devices}")
return devices[0] # Return the first found backlight device
else:
logging.error('No backlight devices found.')
sys.exit(1)
except OSError as e:
logging.error(f"Failed to locate backlight device: {e}")
sys.exit(1)
def run_main_loop(backlight_device, sensitivity_factor, num_readings, max_sensor_value, min_brightness_level, pause, stability_threshold=STABILITY_THRESHOLD, stability_duration=STABILITY_DURATION, step=10, sensor_shift=0):
lock = Lock()
als_device = locate_als_device()
sensor_file1 = f'/sys/bus/iio/devices/{als_device}/in_intensity_both_raw'
sensor_file2 = f'/sys/bus/iio/devices/{als_device}/in_illuminance_raw'
readings = []
last_change_time = time.monotonic()
stable_value = None
cooldown_period = 1 # Start with 1 second cooldown period
while True:
if os.path.exists(PAUSE_FLAG_FILE_PATH):
logging.info("Brightness adjustment is paused due to flag file at {}".format(PAUSE_FLAG_FILE_PATH))
sleep(5)
command = check_for_commands()
if command == "increase":
min_brightness_level += 50
logging.info(f"Min brightness level increased to: {min_brightness_level}")
elif command == "decrease":
min_brightness_level -= 50
logging.info(f"Min brightness level decreased to: {min_brightness_level}")
elif command == "reset":
min_brightness_level = 400
sensitivity_factor = 1.0
sensor_shift = 0
logging.info(f"Min brightness level reset to: {min_brightness_level}")
logging.info(f"Sensitivity factor reset to: {sensitivity_factor}")
logging.info(f"Sensor shift reset to: {sensor_shift}")
elif command == "increase_shift":
sensor_shift += 1
logging.info(f"Sensor shift increased to: {sensor_shift}")
elif command == "decrease_shift":
sensor_shift -= 1
logging.info(f"Sensor shift decreased to: {sensor_shift}")
elif command == "increase_sensitivity":
sensitivity_factor += 0.05
logging.info(f"Sensitivity factor increased to: {sensitivity_factor}")
elif command == "decrease_sensitivity":
sensitivity_factor -= 0.05
logging.info(f"Sensitivity factor decreased to: {sensitivity_factor}")
elif command == "pause":
pause = True
pause_service()
continue
elif command == "resume":
resume_service()
pause = False
elif command == "print":
print_configuration(sensor_shift, sensitivity_factor, min_brightness_level)
if not pause:
# Check for commands, increase min_brightness_level or decrease min_brightness_level
try:
with open(sensor_file1, 'r') as file:
intensity = int(file.read().strip())
# with open(sensor_file2, 'r') as file:
# illuminance = int(file.read().strip())
except OSError as e:
logging.error(f"Failed to read sensor data: {e}")
continue
# average_reading = (intensity + illuminance) // 2
average_reading = intensity
readings.append(average_reading)
readings = readings[-num_readings:]
moving_average = sum(readings) / len(readings)
logging.debug(f"Moving average: {moving_average}")
if stable_value is not None:
logging.debug(f"Stability delta: {abs(moving_average - stable_value)}")
if stable_value is None or abs(moving_average - stable_value) > stability_threshold:
stable_value = moving_average
last_change_time = time.monotonic()
cooldown_period = 1 # Reset cooldown period to 1 second
logging.debug(f"Resetting cooldown period: {cooldown_period}")
elif (time.monotonic() - last_change_time) >= stability_duration:
# If the value has been stable for longer than STABILITY_DURATION, increase cooldown period
cooldown_period = min(cooldown_period * 2, 30) # Maximum cooldown period of 30 seconds
logging.debug(f"Increasing cooldown period: {cooldown_period}")
if cooldown_period == 1 or time.monotonic() - last_change_time < stability_duration:
# Change brightness if not in cooldown or within the stability duration
with lock:
adjust_display_brightness(
moving_average,
backlight_device,
max_sensor_value=max_sensor_value,
sensitivity_factor=sensitivity_factor,
min_brightness_level=min_brightness_level,
step=step,
sensor_shift=sensor_shift)
logging.debug(f"Cooldown period: {cooldown_period}")
sleep(cooldown_period)
else:
sleep(5)
def print_configuration(sensor_shift, sensitivity_factor, min_brightness_level):
logging.info("Adaptive Brightness Configuration:")
logging.info(f"Sensor Shift: {sensor_shift}")
logging.info(f"Sensitivity Factor: {sensitivity_factor}")
logging.info(f"Minimum Brightness Level: {min_brightness_level}")
def start_service(args):
print_configuration(args.sensor_shift, args.sensitivity_factor, args.min_brightness_level)
run_main_loop(
backlight_device=args.backlight_device,
sensitivity_factor=args.sensitivity_factor,
num_readings=args.num_readings,
max_sensor_value=args.max_sensor_value,
min_brightness_level=args.min_brightness_level,
pause=False,
step=args.step,
sensor_shift=args.sensor_shift
)
def pause_service():
# Create a flag file to signal that the service should pause.
try:
with open(PAUSE_FLAG_FILE_PATH, 'w') as f:
pass # The existence of the file is the pause flag; it can be empty.
logging.info("Adaptive brightness adjustment paused. File created: /tmp/adaptive_brightness_pause.flag")
except OSError as e:
logging.error(f"Failed to pause adaptive brightness adjustment: {e}")
pass
def resume_service():
# Remove the flag file to signal that the service should resume.
try:
os.remove(PAUSE_FLAG_FILE_PATH)
logging.info("Adaptive brightness adjustment resumed. File removed: /tmp/adaptive_brightness_pause.flag")
except FileNotFoundError:
logging.warning("Adaptive brightness adjustment was not paused.")
pass
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="LtChipotle's Adaptive Brightness Algorithm")
subparsers = parser.add_subparsers(title='subcommands', description='valid subcommands', help='additional help')
backlight_device_default = locate_backlight_device()
# Start service subcommand
parser_start = subparsers.add_parser('start', help='Start the adaptive brightness service.')
parser_start.add_argument('--min_brightness_level', type=int, default=400, help='The minimum brightness level to be set.')
parser_start.add_argument('--sensor_shift', type=int, default=-2, help='The sensor shift value to be applied. Adjust this value in small amout to shift the curve left or right.')
parser_start.add_argument('--sensitivity_factor', type=float, default=1.0, help='The sensitivity factor for brightness adjustment. (Use sensor shift instead)')
parser_start.add_argument('--step', type=int, default=50, help='The step size to adjust brightness by.')
parser_start.add_argument('--silent', action='store_true', help='Silence all logging.')
parser_start.add_argument('--backlight_device', type=str, default=backlight_device_default, help='The backlight device to control. (DEV)')
parser_start.add_argument('--num_readings', type=int, default=10, help='The number of sensor readings to average. (DEV)')
parser_start.add_argument('--max_sensor_value', type=int, default=2752, help='The maximum sensor value for brightness scaling. (DEV)')
parser_start.set_defaults(func=start_service)
if parser_start.parse_known_args()[0].silent:
logging.disable(logging.CRITICAL)
# Pause service subcommand
parser_pause = subparsers.add_parser('pause', help='Pause the adaptive brightness service.')
parser_pause.set_defaults(func=pause_service)
# Resume service subcommand
parser_resume = subparsers.add_parser('resume', help='Resume the adaptive brightness service.')
parser_resume.set_defaults(func=resume_service)
args = parser.parse_args()
if 'func' in args:
args.func(args)
else:
parser.print_help()