Merge branch 'main' into HeightAdjustment

Author: Drew Chaplin

.github/workflows/release.yml

@@ -33,6 +33,6 @@ jobs:
           zip adaptive_cover.zip -r ./
 
       - name: "Upload the ZIP file to the release"
-        uses: softprops/action-gh-release@v2.0.8
+        uses: softprops/action-gh-release@v2.2.1
         with:
           files: ${{ github.workspace }}/custom_components/adaptive_cover/adaptive_cover.zip

README.md

@@ -188,20 +188,20 @@ This mode is split up in two types of strategies; [Presence](https://github.com/
 
 ### Vertical
 
-| Variables              | Default | Range  | Description                                                                                                                                                                                                |
-| ---------------------- | ------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Window Height          | 2.1     | 0.1-6  | Length of fully extended cover/window                                                                                                                                                                      |
-| Workarea Distance      | 0.5     | 0.1-10 | The distance to the workarea on equal height to the bottom of the cover when fully extended                                                                                                                |
-| Area Height Adjustment | 0.5     | -6 - 6 | The vertical distance from the bottom of the closed blind to the shaded area. Will be negative value for 2nd story windows in tall rooms and postive value when shaded area is higher than base of window. |
+| Variables               | Default | Range  | Description                                                                                                                                                                                                |
+| ----------------------- | ------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| Window Height           | 2.1     | 0.1-6  | Length of fully extended cover/window                                                                                                                                                                      |
+| Glare Zone              | 0.5     | 0.1-10 | Objects within this distance of the cover recieve direct sunlight. Measured horizontally from the bottom of the cover when fully extended                                                                  | extended |
+| Glare Height Adjustment | 0.5     | -6 - 6 | The vertical distance from the bottom of the closed blind to the shaded area. Will be negative value for 2nd story windows in tall rooms and postive value when shaded area is higher than base of window. |
 
 ### Horizontal
 
-| Variables                  | Default | Range | Description                                    |
-| -------------------------- | ------- | ----- | ---------------------------------------------- |
-| Awning Height              | 2       | 0.1-6 | Height from work area to awning mounting point |
-| Awning Length (horizontal) | 2.1     | 0.3-6 | Length of the awning when fully extended       |
-| Awning Angle               | 0       | 0-45  | Angle of the awning from the wall              |
-| Workarea Distance          | 0.5     | 0.1-2 | Distance to the work area                      |
+| Variables                  | Default | Range | Description                                                       |
+| -------------------------- | ------- | ----- | ----------------------------------------------------------------- |
+| Awning Height              | 2       | 0.1-6 | Height from work area to awning mounting point                    |
+| Awning Length (horizontal) | 2.1     | 0.3-6 | Length of the awning when fully extended                          |
+| Awning Angle               | 0       | 0-45  | Angle of the awning from the wall                                 |
+| Glare Zone                 | 0.5     | 0.1-2 | Objects within this distance of the cover recieve direct sunlight |
 
 ### Tilt
 

custom_components/adaptive_cover/__init__.py

@@ -16,6 +16,7 @@
     CONF_TEMP_ENTITY,
     CONF_WEATHER_ENTITY,
     DOMAIN,
+    _LOGGER,
 )
 from .coordinator import AdaptiveDataUpdateCoordinator
 
@@ -48,6 +49,8 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         if entity is not None:
             _entities.append(entity)
 
+    _LOGGER.debug("Setting up entry %s", entry.data.get("name"))
+
     entry.async_on_unload(
         async_track_state_change_event(
             hass,

custom_components/adaptive_cover/calculation.py

@@ -13,13 +13,15 @@
 
 from .helpers import get_domain, get_safe_state
 from .sun import SunData
+from .config_context_adapter import ConfigContextAdapter
 
 
 @dataclass
 class AdaptiveGeneralCover(ABC):
     """Collect common data."""
 
     hass: HomeAssistant
+    logger: ConfigContextAdapter
     sol_azi: float
     sol_elev: float
     sunset_pos: int
@@ -88,6 +90,7 @@ def is_sun_in_blind_spot(self) -> bool:
             blindspot = (self.gamma <= left_edge) & (self.gamma >= right_edge)
             if self.blind_spot_elevation is not None:
                 blindspot = blindspot & (self.sol_elev <= self.blind_spot_elevation)
+            self.logger.debug("Is sun in blind spot? %s", blindspot)
             return blindspot
         return False
 
@@ -119,7 +122,9 @@ def valid_elevation(self) -> bool:
             return self.sol_elev <= self.max_elevation
         if self.max_elevation is None:
             return self.sol_elev >= self.min_elevation
-        return self.min_elevation <= self.sol_elev <= self.max_elevation
+        within_range = self.min_elevation <= self.sol_elev <= self.max_elevation
+        self.logger.debug("elevation within range? %s", within_range)
+        return within_range
 
     @property
     def valid(self) -> bool:
@@ -132,6 +137,7 @@ def valid(self) -> bool:
         valid = (
             (self.gamma < azi_min) & (self.gamma > -azi_max) & (self.valid_elevation)
         )
+        self.logger.debug("Sun in front of window (ignoring blindspot)? %s", valid)
         return valid
 
     @property
@@ -143,6 +149,9 @@ def sunset_valid(self) -> bool:
         before_sunrise = datetime.utcnow() < (
             sunrise + timedelta(minutes=self.sunrise_off)
         )
+        self.logger.debug(
+            "After sunset plus offset? %s", (after_sunset or before_sunrise)
+        )
         return after_sunset or before_sunrise
 
     @property
@@ -197,11 +206,20 @@ class NormalCoverState:
 
     def get_state(self) -> int:
         """Return state."""
-        state = np.where(
-            self.cover.direct_sun_valid,
-            self.cover.calculate_percentage(),
-            self.cover.default,
+        self.cover.logger.debug("Determining normal position")
+        dsv = self.cover.direct_sun_valid
+        self.cover.logger.debug(
+            "Sun directly in front of window & before sunset + offset? %s", dsv
         )
+        if dsv:
+            state = self.cover.calculate_percentage()
+            self.cover.logger.debug(
+                "Yes sun in window: using calculated percentage (%s)", state
+            )
+        else:
+            state = self.cover.default
+            self.cover.logger.debug("No sun in window: using default value (%s)", state)
+
         result = np.clip(state, 0, 100)
         if self.cover.apply_max_position and result > self.cover.max_pos:
             return self.cover.max_pos
@@ -215,6 +233,7 @@ class ClimateCoverData:
     """Fetch additional data."""
 
     hass: HomeAssistant
+    logger: ConfigContextAdapter
     temp_entity: str
     temp_low: float
     temp_high: float
@@ -289,8 +308,17 @@ def is_presence(self):
     def is_winter(self) -> bool:
         """Check if temperature is below threshold."""
         if self.temp_low is not None and self.get_current_temperature is not None:
-            return self.get_current_temperature < self.temp_low
-        return False
+            is_it = self.get_current_temperature < self.temp_low
+        else:
+            is_it = False
+
+        self.logger.debug(
+            "is_winter(): current_temperature < temp_low: %s < %s = %s",
+            self.get_current_temperature,
+            self.temp_low,
+            is_it,
+        )
+        return is_it
 
     @property
     def outside_high(self) -> bool:
@@ -306,8 +334,18 @@ def outside_high(self) -> bool:
     def is_summer(self) -> bool:
         """Check if temperature is over threshold."""
         if self.temp_high is not None and self.get_current_temperature is not None:
-            return self.get_current_temperature > self.temp_high and self.outside_high
-        return False
+            is_it = self.get_current_temperature > self.temp_high and self.outside_high
+        else:
+            is_it = False
+
+        self.logger.debug(
+            "is_summer(): current_temp > temp_high and outside_high?: %s > %s and %s = %s",
+            self.get_current_temperature,
+            self.temp_high,
+            self.outside_high,
+            is_it,
+        )
+        return is_it
 
     @property
     def is_sunny(self) -> bool:
@@ -316,9 +354,12 @@ def is_sunny(self) -> bool:
         if self.weather_entity is not None:
             weather_state = get_safe_state(self.hass, self.weather_entity)
         else:
+            self.logger.debug("is_sunny(): No weather entity defined")
             return True
         if self.weather_condition is not None:
-            return weather_state in self.weather_condition
+            matches = weather_state in self.weather_condition
+            self.logger.debug("is_sunny(): Weather: %s = %s", weather_state, matches)
+            return matches
 
     @property
     def lux(self) -> bool:
@@ -349,6 +390,9 @@ class ClimateCoverState(NormalCoverState):
 
     def normal_type_cover(self) -> int:
         """Determine state for horizontal and vertical covers."""
+
+        self.cover.logger.debug("Is presence? %s", self.climate_data.is_presence)
+
         if self.climate_data.is_presence:
             return self.normal_with_presence()
 
@@ -357,23 +401,32 @@ def normal_type_cover(self) -> int:
     def normal_with_presence(self) -> int:
         """Determine state for horizontal and vertical covers with occupants."""
 
+        is_summer = self.climate_data.is_summer
+
         # Check if it's not summer and either lux, irradiance or sunny weather is present
-        if not self.climate_data.is_summer and (
+        if not is_summer and (
             self.climate_data.lux
             or self.climate_data.irradiance
             or not self.climate_data.is_sunny
         ):
             # If it's winter and the cover is valid, return 100
             if self.climate_data.is_winter and self.cover.valid:
+                self.cover.logger.debug(
+                    "n_w_p(): Winter and sun is in front of window = use 100"
+                )
                 return 100
             # Otherwise, return the default cover state
+            self.cover.logger.debug(
+                "n_w_p(): it's not summer and sunny weather is not present = use default"
+            )
             return self.cover.default
 
         # If it's summer and there's a transparent blind, return 0
-        if self.climate_data.is_summer and self.climate_data.transparent_blind:
+        if is_summer and self.climate_data.transparent_blind:
             return 0
 
         # If none of the above conditions are met, get the state from the parent class
+        self.cover.logger.debug("n_w_p(): None of the climate conditions are met")
         return super().get_state()
 
     def normal_without_presence(self) -> int:
@@ -426,8 +479,18 @@ def get_state(self) -> int:
         if self.climate_data.blind_type == "cover_tilt":
             result = self.tilt_state()
         if self.cover.apply_max_position and result > self.cover.max_pos:
+            self.cover.logger.debug(
+                "Climate state: Max position applied (%s > %s)",
+                result,
+                self.cover.max_pos,
+            )
             return self.cover.max_pos
         if self.cover.apply_min_position and result < self.cover.min_pos:
+            self.cover.logger.debug(
+                "Climate state: Min position applied (%s < %s)",
+                result,
+                self.cover.min_pos,
+            )
             return self.cover.min_pos
         return result
 
@@ -453,7 +516,11 @@ def calculate_position(self) -> float:
 
     def calculate_percentage(self) -> float:
         """Convert blind height to percentage or default value."""
-        result = self.calculate_position() / self.h_win * 100
+        position = self.calculate_position()
+        self.logger.debug(
+            "Converting height to percentage: %s / %s * 100", position, self.h_win
+        )
+        result = position / self.h_win * 100
         return round(result)
 
 

custom_components/adaptive_cover/config_context_adapter.py

@@ -0,0 +1,43 @@
+"""This module provides a logging adapter that adds a configuration name to log messages."""
+
+import logging
+
+
+class ConfigContextAdapter(logging.LoggerAdapter):
+    """A logging adapter that adds a configuration name to log messages."""
+
+    def __init__(self, logger, extra=None):
+        """Initialize the ConfigContextAdapter.
+
+        Args:
+            logger (logging.Logger): The logger instance to which this adapter is attached.
+            extra (dict, optional): Additional context information. Defaults to None.
+
+        """
+        super().__init__(logger, extra or {})
+        self.config_name = None
+
+    def set_config_name(self, config_name):
+        """Set the configuration name.
+
+        Args:
+            config_name (str): The name of the configuration to set.
+
+        """
+        self.config_name = config_name
+
+    def process(self, msg, kwargs):
+        """Process the log message and add the configuration name if set.
+
+        Args:
+            msg (str): The log message.
+            kwargs (dict): Additional keyword arguments.
+
+        Returns:
+            tuple: The processed log message and keyword arguments.
+
+        """
+        if self.config_name:
+            return f"[{self.config_name}] {msg}", kwargs
+        else:
+            return f"[Unknown] {msg}", kwargs