Skip to content

Home Information - Your home, your data, organized.

Python

Minor refactor from mixin to SensorResponseManager.

Anthony Cassandraa20c10409a4e
diff --git a/src/hi/apps/monitor/monitor_mixin.py b/src/hi/apps/sense/sensor_response_manager.py
similarity index 84%
rename from src/hi/apps/monitor/monitor_mixin.py
rename to src/hi/apps/sense/sensor_response_manager.py
index 7263e1c6..691bc135 100644
--- a/src/hi/apps/monitor/monitor_mixin.py
+++ b/src/hi/apps/sense/sensor_response_manager.py
@@ -9,8 +9,15 @@ from hi.integrations.core.integration_key import IntegrationKey
logger = logging.getLogger(__name__)
-class SensorMonitorMixin:
-
+class SensorResponseManager:
+ """
+ Integrations are responsible for monitoring sensor values and
+ normalizing them into SensorResponse objects. This module take it from
+ there to store these for tracking the latest state and sensor history.
+ i.e., Integrations should be using this module to submit sensor
+ values changes.
+ """
+
def add_to_sensor_response_history( self, sensor_response_list : List[ SensorResponse ] ):
if not sensor_response_list:
return
@@ -56,8 +63,7 @@ class SensorMonitorMixin:
self.add_to_sensor_response_history( changed_sensor_response_list )
self.add_latest_sensor_responses( changed_sensor_response_list )
- if self.TRACE:
- logger.debug( f'HAss Changed: {len(changed_sensor_response_list)} of {len(sensor_response_map)}' )
+ logger.debug( f'Sensor changed: {len(changed_sensor_response_list)} of {len(sensor_response_map)}' )
return
def to_sensor_value_cache_key( self, integration_key : IntegrationKey ):
diff --git a/src/hi/integrations/hass/hass_monitor.py b/src/hi/integrations/hass/hass_monitor.py
index 5b241e89..4cf0112f 100644
--- a/src/hi/integrations/hass/hass_monitor.py
+++ b/src/hi/integrations/hass/hass_monitor.py
@@ -2,8 +2,8 @@ import logging
import hi.apps.common.datetimeproxy as datetimeproxy
from hi.apps.monitor.periodic_monitor import PeriodicMonitor
-from hi.apps.monitor.monitor_mixin import SensorMonitorMixin
from hi.apps.monitor.transient_models import SensorResponse
+from hi.apps.sense.sensor_response_manager import SensorResponseManager
from .hass_converter import HassConverter
from .hass_manager import HassManager
@@ -11,19 +11,20 @@ from .hass_manager import HassManager
logger = logging.getLogger(__name__)
-class HassMonitor( PeriodicMonitor, SensorMonitorMixin ):
+class HassMonitor( PeriodicMonitor ):
def __init__( self ):
super().__init__(
id = 'hass-monitor',
interval_secs = 10,
)
- self._manager = HassManager()
+ self._hass_manager = HassManager()
+ self._sensor_response_manager = SensorResponseManager()
self._logger = logging.getLogger(__name__)
return
async def do_work(self):
- id_to_hass_state_map = self._manager.fetch_hass_states_from_api( verbose = False )
+ id_to_hass_state_map = self._hass_manager.fetch_hass_states_from_api( verbose = False )
if self.TRACE:
logger.debug( f'Fetched {len(id_to_hass_state_map)} HAss States' )
@@ -44,6 +45,8 @@ class HassMonitor( PeriodicMonitor, SensorMonitorMixin ):
sensor_response_latest_map[integration_key] = sensor_response
continue
- self.update_with_latest_sensor_responses( sensor_response_latest_map )
+ self._sensor_response_manager.update_with_latest_sensor_responses(
+ sensor_response_map = sensor_response_latest_map,
+ )
return
diff --git a/src/hi/integrations/zoneminder/zm_monitor.py b/src/hi/integrations/zoneminder/zm_monitor.py
index 5fad89ca..708c4db2 100644
--- a/src/hi/integrations/zoneminder/zm_monitor.py
+++ b/src/hi/integrations/zoneminder/zm_monitor.py
@@ -3,9 +3,9 @@ import logging
import hi.apps.common.datetimeproxy as datetimeproxy
from hi.apps.monitor.periodic_monitor import PeriodicMonitor
-from hi.apps.monitor.monitor_mixin import SensorMonitorMixin
from hi.apps.monitor.transient_models import SensorResponse
from hi.apps.sense.enums import SensorValue
+from hi.apps.sense.sensor_response_manager import SensorResponseManager
from .zm_models import ZmEvent
from .zm_manager import ZoneMinderManager
@@ -13,7 +13,7 @@ from .zm_manager import ZoneMinderManager
logger = logging.getLogger(__name__)
-class ZoneMinderMonitor( PeriodicMonitor, SensorMonitorMixin ):
+class ZoneMinderMonitor( PeriodicMonitor ):
# TODO: Move this into the integrations attributes for users to set
ZONEMINDER_SERVER_TIMEZONE = 'America/Chicago'
@@ -23,7 +23,8 @@ class ZoneMinderMonitor( PeriodicMonitor, SensorMonitorMixin ):
id = 'zm-monitor',
interval_secs = 10,
)
- self._manager = ZoneMinderManager()
+ self._zm_manager = ZoneMinderManager()
+ self._sensor_response_manager = SensorResponseManager()
self._fully_processed_event_ids = TTLCache( maxsize = 1000, ttl = 100000 )
self._start_processed_event_ids = TTLCache( maxsize = 1000, ttl = 100000 )
@@ -41,7 +42,7 @@ class ZoneMinderMonitor( PeriodicMonitor, SensorMonitorMixin ):
'from': self._poll_from_datetime.isoformat(), # This "from" only looks at event start time
'tz': self.ZONEMINDER_SERVER_TIMEZONE,
}
- response = self._manager.zm_client.events( options )
+ response = self._zm_manager.zm_client.events( options )
events = response.list()
if self.TRACE:
logger.debug( f"Found {len(events)} new ZM events" )
@@ -99,8 +100,12 @@ class ZoneMinderMonitor( PeriodicMonitor, SensorMonitorMixin ):
self._start_processed_event_ids[zm_event.event_id] = True
continue
- self.add_to_sensor_response_history( sensor_response_list = sensor_response_history_list )
- self.add_latest_sensor_responses( sensor_response_list = sensor_response_latest_list )
+ self._sensor_response_manager.add_to_sensor_response_history(
+ sensor_response_list = sensor_response_history_list,
+ )
+ self._sensor_response_manager.add_latest_sensor_responses(
+ sensor_response_list = sensor_response_latest_list,
+ )
if open_zm_event_list:
# Ensure that we will continue to poll for all the open events we
@@ -130,8 +135,8 @@ class ZoneMinderMonitor( PeriodicMonitor, SensorMonitorMixin ):
def _create_movement_active_sensor_response( self, zm_event : ZmEvent ):
return SensorResponse(
- integration_key = self._manager._sensor_to_integration_key(
- sensor_prefix = self._manager.MOVEMENT_SENSOR_PREFIX,
+ integration_key = self._zm_manager._sensor_to_integration_key(
+ sensor_prefix = self._zm_manager.MOVEMENT_SENSOR_PREFIX,
zm_monitor_id = zm_event.monitor_id,
),
value = str(SensorValue.MOVEMENT_ACTIVE),
@@ -140,8 +145,8 @@ class ZoneMinderMonitor( PeriodicMonitor, SensorMonitorMixin ):
def _create_movement_idle_sensor_response( self, zm_event : ZmEvent ):
return SensorResponse(
- integration_key = self._manager._sensor_to_integration_key(
- sensor_prefix = self._manager.MOVEMENT_SENSOR_PREFIX,
+ integration_key = self._zm_manager._sensor_to_integration_key(
+ sensor_prefix = self._zm_manager.MOVEMENT_SENSOR_PREFIX,
zm_monitor_id = zm_event.monitor_id,
),
value = str(SensorValue.MOVEMENT_IDLE),