Home Information - Your home, your data, organized.
Python
Working on event detector. WIP
Anthony Cassandra79b2d92bb97a
diff --git a/src/hi/apps/common/models.py b/src/hi/apps/common/models.pyindex 3b04ec5f..6cfbdfa7 100644--- a/src/hi/apps/common/models.py+++ b/src/hi/apps/common/models.py@@ -4,7 +4,6 @@ from django.db import models, transactionfrom django.utils import timezone-class DatabaseLock(models.Model):name = models.CharField(diff --git a/src/hi/apps/event/enums.py b/src/hi/apps/event/enums.pynew file mode 100644index 00000000..09065c94--- /dev/null+++ b/src/hi/apps/event/enums.py@@ -0,0 +1,68 @@+from hi.apps.common.enums import LabeledEnum+++class EventLevel(LabeledEnum):++ NONE = ( 'None' , '' , 0 )+ INFO = ( 'Info' , '' , 10 )+ WARNING = ( 'Warning' , '' , 100 )+ CRITICAL = ( 'Critical' , '' , 1000 )++ def __init__( self,+ label : str,+ description : str,+ priority : int ):+ super().__init__( label, description )+ self.priority = priority+ return+++class SecurityLevel(LabeledEnum):+ """+ This is the overall security level setting for security status monitoring+ that dictates what type of security events are relevant.+ """++ UNKNOWN = ( 'Unknown' , '' )+ DISABLED = ( 'Disabled' , '' )+ HOME = ( 'Home' , '' )+ NIGHT = ( 'Night' , '' )+ AWAY = ( 'Away' , '' )+ ERROR = ( 'Error' , '' )+++class SecurityState(LabeledEnum):++ ERROR = ( 'Error' , '' , -12 )+ UNKNOWN = ( 'Unknown' , '' , -3 )+ DISABLED = ( 'Disabled' , '' , -1 )+ ENABLED = ( 'Enabled' , '' , 0 )+ IDLE = ( 'Idle' , '' , 1 )+ INFO_RECENT = ( 'Info (recent)' , '' , 9 )+ INFO = ( 'Info' , '' , 10 )+ ALERT_RECENT = ( 'Alert (recent)' , '' , 99 )+ ALERT = ( 'Alert' , '' , 100 )+ ALARM_RECENT = ( 'Alarm (recent)' , '' , 999 )+ ALARM = ( 'Alarm' , '' , 1000 )++ def __init__( self,+ label : str,+ description : str,+ priority : int ):+ super().__init__( label, description )+ self.priority = priority+ return++ @staticmethod+ def get_recent_variant( cls, security_state : 'SecurityState' ):+ """+ Converts a state to its 'recent' version if one exists.+ Otherwise, just returns the state passed in.+ """+ if security_state == cls.INFO:+ return cls.INFO_RECENT+ if security_state == cls.ALERT:+ return cls.ALERT_RECENT+ if security_state == cls.ALARM:+ return cls.ALARM_RECENT+ return security_statediff --git a/src/hi/apps/event/event_detector.py b/src/hi/apps/event/event_detector.pyindex edea770b..68113ad6 100644--- a/src/hi/apps/event/event_detector.py+++ b/src/hi/apps/event/event_detector.py@@ -1,17 +1,104 @@+from asgiref.sync import sync_to_async+from cachetools import TTLCache+from collections import dequefrom typing import List+import hi.apps.common.datetimeproxy as datetimeproxyfrom hi.apps.common.singleton import Singleton-from .transient_models import EntityStateTransition+from .models import EventDefinition+from .transient_models import Event, EntityStateTransitionclass EventDetector(Singleton):def __init_singleton__(self):+ self._recent_transitions = deque()+ self._recent_events = TTLCache( maxsize = 1000, ttl = 300 )+ self.reload()return- def add_entity_state_transitions( self, entity_state_transition_list : List[ EntityStateTransition ] ):+ def reload(self):+ sync_to_async( self._reload_helper )()+ return+ def _reload_helper(self):+ self._event_definitions = EventDefinition.objects.prefetch_related('clauses').filter( enabled = True )+ self._max_event_window_secs = max([ x.event_window_secs for x in self._event_definitions ])+ return++ def add_entity_state_transitions( self, entity_state_transition_list : List[ EntityStateTransition ] ):+ if not entity_state_transition_list:+ return+ self._recent_transitions.extend( entity_state_transition_list )+ self._purge_old_transitions()+ self._check_for_new_events()return-+ def _check_for_new_events( self ):+ new_event_list = list()+ for event_definition in self._event_definitions:+ if self._has_recent_event( event_definition ):+ continue+ event = self._create_event_if_detected( event_definition )+ if not event:+ continue+ self._recent_events[event_definition.id] = event+ new_event_list.append( event )+ continue++ self._handle_new_events( event_list = new_event_list )+ self._add_to_event_history( event_list = new_event_list )+ return++ def _has_recent_event( self, event_definition : EventDefinition ) -> bool:+ recent_event = self._recent_events.get( event_definition.id )+ if not recent_event:+ return False+ recent_event_timedelta = datetimeproxy.now() - recent_event.timestamp+ return bool( recent_event_timedelta <= event_definition.event_window_secs )++ def _create_event_if_detected( self, event_definition : EventDefinition ) -> bool:+ if not event_definition.clauses.exists():+ return False++ current_timestamp = datetimeproxy.now()+ sensor_response_list = list()++ for event_clause in event_definition.clauses.all():+ matches = False+ for transition in self._recent_transitions:+ if transition.entity_state != event_clause.entity_state:+ continue+ if transition.latest_sensor_response.value != event_clause.value:+ continue+ transition_timedelta = current_timestamp - transition.timestamp+ if transition_timedelta.seconds > event_definition.event_window_secs:+ continue+ matches = True+ sensor_response_list.append( transition.latest_sensor_response )+ break+ if not matches:+ return False+ continue++ return Event(+ event_definition = event_definition,+ sensor_response_list = sensor_response_list,+ )++ def _purge_old_transitions( self ):+ current_timestamp = datetimeproxy.now()+ while ( self._recent_transitions+ and (( current_timestamp - self._recent_transitions[0].timestamp )+ > self._max_event_window_secs )):+ self._recent_transitions.popleft()+ continue+ return++ def _handle_new_events( self, event_list : List[ Event ] ):+ raise NotImplementedError()++ def _add_to_event_history( self, event_list : List[ Event ] ):+ raise NotImplementedError()+diff --git a/src/hi/apps/event/models.py b/src/hi/apps/event/models.pyindex 71a83623..510b19e3 100644--- a/src/hi/apps/event/models.py+++ b/src/hi/apps/event/models.py@@ -1,3 +1,90 @@from django.db import models-# Create your models here.+from hi.apps.entity.models import EntityState+++class EventDefinition( models.Model ):++ name = models.CharField(+ 'Name',+ max_length = 64,+ )+ severity_levels_str = models.TextField(+ 'Severity Levels',+ blank = True, null = True,+ )+ event_window_secs = models.PositiveIntegerField(+ 'Event Window Secs',+ )+ enabled = models.BooleanField(+ default = True,+ )+ created_datetime = models.DateTimeField(+ 'Created',+ auto_now_add = True,+ blank = True,+ )+ updated_datetime = models.DateTimeField(+ 'Updated',+ auto_now = True,+ blank = True,+ )++ class Meta:+ verbose_name = 'Event Definition'+ verbose_name_plural = 'Event Definitions'+++class EventClause( models.Model ):++ event_definition = models.ForeignKey(+ EventDefinition,+ related_name = 'clauses',+ verbose_name = 'Event Definition',+ on_delete = models.CASCADE,+ )+ entity_state = models.ForeignKey(+ EntityState,+ related_name = '+',+ verbose_name = 'Entity State',+ on_delete = models.CASCADE,+ )+ value = models.CharField(+ 'Value',+ max_length = 255+ )+ created_datetime = models.DateTimeField(+ 'Created',+ auto_now_add = True,+ blank = True,+ )+ updated_datetime = models.DateTimeField(+ 'Updated',+ auto_now = True,+ blank = True,+ )++ class Meta:+ verbose_name = 'Event Clause'+ verbose_name_plural = 'Event Clauses'+++class EventHistory( models.Model ):++++++++++ created_datetime = models.DateTimeField(+ 'Created',+ auto_now_add = True,+ blank = True,+ )++ class Meta:+ verbose_name = 'Event History'+ verbose_name_plural = 'Event History'diff --git a/src/hi/apps/event/transient_models.py b/src/hi/apps/event/transient_models.pyindex a7099e90..a5004bf8 100644--- a/src/hi/apps/event/transient_models.py+++ b/src/hi/apps/event/transient_models.py@@ -1,14 +1,30 @@from dataclasses import dataclass-from datetime import datetime+from typing import Listfrom hi.apps.entity.models import EntityState+from hi.apps.sense.transient_models import SensorResponse++from .models import EventDefinition@dataclassclass EntityStateTransition:- entity_state : EntityState- from_value : str- to_value : str- timestamp : datetime+ entity_state : EntityState+ latest_sensor_response : SensorResponse+ previous_value : str++ @property+ def timestamp(self):+ return self.latest_sensor_response.timestamp+++@dataclass+class Event:+ event_definition : EventDefinition+ sensor_response_list : List[ SensorResponse ]++ @property+ def timestamp(self):+ return max([ x.timestamp for x in self.sensor_response_list ])diff --git a/src/hi/apps/sense/sensor_response_manager.py b/src/hi/apps/sense/sensor_response_manager.pyindex a1791b69..97c72b90 100644--- a/src/hi/apps/sense/sensor_response_manager.py+++ b/src/hi/apps/sense/sensor_response_manager.py@@ -182,9 +182,8 @@ class SensorResponseManager( Singleton ):return Nonereturn EntityStateTransition(entity_state = sensor.entity_state,- from_value = previous_sensor_response.value,- to_value = latest_sensor_response.value,- timestamp = latest_sensor_response.timestamp,+ latest_sensor_response = latest_sensor_response,+ previous_value = previous_sensor_response.value,)def _get_sensor( self, integration_key : IntegrationKey ):