basnijholt
commented
1 year ago Some code to plot the results:
import numpy as np
import matplotlib.pyplot as plt
import math
from typing import Tuple
import mplcyberpunk
plt.style.use("cyberpunk")
def lerp(x, x1, x2, y1, y2):
"""Linearly interpolate between two values."""
return y1 + (x - x1) * (y2 - y1) / (x2 - x1)
def clamp(value: float, minimum: float, maximum: float) -> float:
"""Clamp value between minimum and maximum."""
return max(minimum, min(value, maximum))
def find_a_b(x1: float, x2: float, y1: float, y2: float) -> Tuple[float, float]:
a = (math.atanh(2 * y2 - 1) - math.atanh(2 * y1 - 1)) / (x2 - x1)
b = x1 - (math.atanh(2 * y1 - 1) / a)
return a, b
def scaled_tanh(
x: float,
a: float,
b: float,
y_min: float = 0.0,
y_max: float = 1.0,
) -> float:
"""Apply a scaled and shifted tanh function to a given input."""
return y_min + (y_max - y_min) * 0.5 * (math.tanh(a * (x - b)) + 1)
def is_closer_to_sunrise_than_sunset(time, sunrise_time, sunset_time):
"""Return True if the time is closer to sunrise than sunset."""
return abs(time - sunrise_time) < abs(time - sunset_time)
def brightness_linear(
time,
sunrise_time,
sunset_time,
time_light,
time_dark,
max_brightness,
min_brightness,
):
"""Calculate the brightness for the 'linear' mode."""
closer_to_sunrise = is_closer_to_sunrise_than_sunset(
time, sunrise_time, sunset_time
)
if closer_to_sunrise:
brightness = lerp(
time,
x1=sunrise_time - time_dark,
x2=sunrise_time + time_light,
y1=min_brightness,
y2=max_brightness,
)
else:
brightness = lerp(
time,
x1=sunset_time - time_light,
x2=sunset_time + time_dark,
y1=max_brightness,
y2=min_brightness,
)
return clamp(brightness, min_brightness, max_brightness)
def brightness_tanh(
time,
sunrise_time,
sunset_time,
time_light,
time_dark,
max_brightness,
min_brightness,
):
"""Calculate the brightness for the 'tanh' mode."""
closer_to_sunrise = is_closer_to_sunrise_than_sunset(
time, sunrise_time, sunset_time
)
if closer_to_sunrise:
a, b = find_a_b(
x1=-time_dark,
x2=time_light,
y1=0.05, # be at 5% of range at x1
y2=0.95, # be at 95% of range at x2
)
brightness = scaled_tanh(
time - sunrise_time,
a=a,
b=b,
y_min=min_brightness,
y_max=max_brightness,
)
else:
a, b = find_a_b(
x1=-time_light, # shifted timestamp for the start of sunset
x2=time_dark, # shifted timestamp for the end of sunset
y1=0.95, # be at 95% of range at the start of sunset
y2=0.05, # be at 5% of range at the end of sunset
)
brightness = scaled_tanh(
time - sunset_time,
a=a,
b=b,
y_min=min_brightness,
y_max=max_brightness,
)
return clamp(brightness, min_brightness, max_brightness)
# Define the constants
sunrise_time = 6 # 6 AM
sunset_time = 18 # 6 PM
max_brightness = 1.0 # 100%
min_brightness = 0.3 # 30%
brightness_mode_time_dark = 3.0
brightness_mode_time_light = 0.5
for min_brightness, brightness_mode_time_dark, brightness_mode_time_light in [
(0.0, 2, 0),
(0.0, 0, 2),
(0.3, 3.0, 0.5),
(0.1, 4, 4)
]:
# Define the time range for our simulation
time_range = np.linspace(0, 24, 1000) # From 0 to 24 hours
# Calculate the brightness for each time in the time range for both modes
brightness_linear_values = [
brightness_linear(
time,
sunrise_time,
sunset_time,
brightness_mode_time_light,
brightness_mode_time_dark,
max_brightness,
min_brightness,
)
for time in time_range
]
brightness_tanh_values = [
brightness_tanh(
time,
sunrise_time,
sunset_time,
brightness_mode_time_light,
brightness_mode_time_dark,
max_brightness,
min_brightness,
)
for time in time_range
]
# Plot the brightness over time for both modes
plt.figure(figsize=(10, 6))
plt.plot(time_range, brightness_linear_values, label="Linear Mode")
plt.plot(time_range, brightness_tanh_values, label="Tanh Mode")
plt.vlines(sunrise_time, 0, 1, color="C2", label="Sunrise", linestyles="dashed")
plt.vlines(sunset_time, 0, 1, color="C3", label="Sunset", linestyles="dashed")
plt.xlim(0, 24)
plt.xticks(np.arange(0, 25, 1))
yticks = np.arange(0, 1.05, 0.05)
ytick_labels = [f"{100*label:.0f}%" for label in yticks]
plt.yticks(yticks, ytick_labels)
plt.xlabel("Time (hours)")
plt.ylabel("Brightness")
plt.title("Brightness over Time for Different Modes")
# Add text box
textstr = "\n".join(
(
f"Sunrise Time = {sunrise_time}:00:00",
f"Sunset Time = {sunset_time}:00:00",
f"Max Brightness = {max_brightness*100:.0f}%",
f"Min Brightness = {min_brightness*100:.0f}%",
f"Time Light = {brightness_mode_time_light} hours",
f"Time Dark = {brightness_mode_time_dark} hours",
)
)
# these are matplotlib.patch.Patch properties
props = dict(boxstyle="round", facecolor="wheat", alpha=0.5)
plt.legend()
plt.grid(True)
mplcyberpunk.add_glow_effects()
# place a text box in upper left in axes coords
plt.gca().text(
0.4,
0.55,
textstr,
transform=plt.gca().transAxes,
fontsize=10,
verticalalignment="center",
bbox=props,
)
plt.show()
pacjo
funkytwig
protyposis
TheWanderer1983
This PR allows setting different
brightness_modes which determine how the brightness changes around sunrise and sunset. Herebrightness_modecan be either"default"(current behavior),"linear", or"tanh". Additionally, when not using"default", you can setbrightness_mode_time_darkandbrightness_mode_time_light.with
brightness_mode: "linear":max_brightnessattime=sunset_time - brightness_mode_time_lighttomin_brightnessattime=sunset_time + brightness_mode_time_dark.min_brightnessattime=sunrise_time - brightness_mode_time_darktomax_brightnessattime=sunrise_time + brightness_mode_time_light.with
brightness_mode: "tanh"it uses the smooth shape of a hyperbolic tangent function:max_brightnessattime=sunset_time - brightness_mode_time_lightto 5% of themin_brightnessattime=sunset_time + brightness_mode_time_dark.min_brightnessattime=sunrise_time - brightness_mode_time_darkto 95% of themax_brightnessattime=sunrise_time + brightness_mode_time_light.Closes https://github.com/basnijholt/adaptive-lighting/issues/616, https://github.com/basnijholt/adaptive-lighting/issues/437, https://github.com/basnijholt/adaptive-lighting/issues/218, https://github.com/basnijholt/adaptive-lighting/issues/242, https://github.com/basnijholt/adaptive-lighting/issues/127, https://github.com/basnijholt/adaptive-lighting/issues/94, https://github.com/basnijholt/adaptive-lighting/issues/72