Skip to content

Home Information - Your home, your data, organized.

Python

Improved propagation of sensor/event/alarm/alert details for UI.

Anthony Cassandraa0ba2acf27c8
diff --git a/src/hi/apps/alert/alarm.py b/src/hi/apps/alert/alarm.py
index 13694a75..f61563c1 100644
--- a/src/hi/apps/alert/alarm.py
+++ b/src/hi/apps/alert/alarm.py
@@ -1,16 +1,24 @@
from dataclasses import dataclass
from datetime import datetime
+from typing import Dict, List
from .enums import AlarmLevel, AlarmSource, SecurityPosture
+@dataclass
+class AlarmSourceDetails:
+
+ detail_attrs : Dict[ str, str ]
+ image_url : str = None
+
+
@dataclass
class Alarm:
alarm_source : AlarmSource
alarm_type : str
alarm_level : AlarmLevel
title : str
- details : str
+ source_details_list : List[ AlarmSourceDetails ]
security_posture : SecurityPosture
alarm_lifetime_secs : int
timestamp : datetime
diff --git a/src/hi/apps/alert/alert.py b/src/hi/apps/alert/alert.py
index e0c69937..a6defbd0 100644
--- a/src/hi/apps/alert/alert.py
+++ b/src/hi/apps/alert/alert.py
@@ -33,10 +33,6 @@ class Alert:
def id(self) -> str:
return self._id
- @property
- def alarm_list(self) -> List[ Alarm ]:
- return list( self._latest_alarms )
-
@property
def start_datetime(self) -> datetime:
return self._start_datetime
@@ -49,10 +45,6 @@ class Alert:
def audio_signal(self) -> AudioSignal:
return self._first_alarm.audio_signal
- @property
- def alarm_level(self) -> AlarmLevel:
- return self._first_alarm.alarm_level
-
@property
def alarm_source(self) -> AlarmSource:
return self._first_alarm.alarm_source
@@ -61,10 +53,18 @@ class Alert:
def alarm_type(self) -> AlarmSource:
return self._first_alarm.alarm_type
+ @property
+ def alarm_level(self) -> AlarmLevel:
+ return self._first_alarm.alarm_level
+
@property
def alarm_count(self) -> int:
return len( self._latest_alarms )
+ @property
+ def alarm_list(self) -> List[ Alarm ]:
+ return list( self._latest_alarms )
+
@property
def title(self) -> str:
return self._first_alarm.title
diff --git a/src/hi/apps/alert/alert_manager.py b/src/hi/apps/alert/alert_manager.py
index c1a651d0..8b255eb7 100644
--- a/src/hi/apps/alert/alert_manager.py
+++ b/src/hi/apps/alert/alert_manager.py
@@ -3,6 +3,7 @@ import logging
from hi.apps.common.singleton import Singleton
+from .alert import Alert
from .alert_queue import AlertQueue
from .alarm import Alarm
from .alert_status import AlertStatusData
@@ -20,6 +21,9 @@ class AlertManager(Singleton):
def unacknowledged_alert_list(self):
return self._alert_queue.unacknowledged_alert_list
+ def get_alert( self, alert_id : str ) -> Alert:
+ return self._alert_queue.get_alert( alert_id = alert_id )
+
def get_alert_status_data( self, last_alert_status_datetime : datetime ) -> AlertStatusData:
# Things to check on alert status:
@@ -67,7 +71,7 @@ class AlertManager(Singleton):
async def add_alarm( self, alarm : Alarm ):
logging.debug( f'Adding Alarm: {alarm}' )
try:
- self._alert_queue.add_alarm()
+ self._alert_queue.add_alarm( alarm = alarm )
except ValueError as ve:
logging.info( str(ve) )
return
diff --git a/src/hi/apps/alert/alert_queue.py b/src/hi/apps/alert/alert_queue.py
index ac6c1c08..398efba8 100644
--- a/src/hi/apps/alert/alert_queue.py
+++ b/src/hi/apps/alert/alert_queue.py
@@ -53,6 +53,13 @@ class AlertQueue:
def unacknowledged_alert_list(self):
return [ x for x in self._alert_list if not x.is_acknowledged ]
+ def get_alert( self, alert_id : str ) -> Alert:
+ for alert in self._alert_list:
+ if alert.id == alert_id:
+ return alert
+ continue
+ raise KeyError( f'Alert not found for {alert_id}' )
+
def get_most_important_alert( self, since_datetime : datetime = None ):
"""
Returns the active alert that has the highest priority and which was
diff --git a/src/hi/apps/alert/templates/alert/modals/alert_details.html b/src/hi/apps/alert/templates/alert/modals/alert_details.html
new file mode 100644
index 00000000..0c0d317e
--- /dev/null
+++ b/src/hi/apps/alert/templates/alert/modals/alert_details.html
@@ -0,0 +1,30 @@
+{% extends "modals/action_done.html" %}
+{% load humanize %}
+
+{% block title_text %}
+{{ alert.title }}
+{% endblock %}
+
+{% block body %}
+<div>
+ Alert Source: {{ alert.alarm_source.label }}
+</div>
+<div>
+ Alert Level: {{ alert.alarm_level.label }}
+</div>
+<div>
+ Alert Type: {{ alert.alarm_type }}
+</div>
+<div>
+ When: {{ alert.start_datetime|naturaltime }}
+</div>
+
+<div>
+ {% for alarm in alert.alarm_list %}
+ {% if alert.alarm_count > 1 %}
+ <h5>Alarm {{ forloop.counter }}: {{ alarm.title }}</h5>
+ {% endif %}
+ {% include "alert/panes/alarm_details.html" %}
+ {% endfor %}
+</div>
+{% endblock %}
diff --git a/src/hi/apps/alert/templates/alert/panes/alarm_details.html b/src/hi/apps/alert/templates/alert/panes/alarm_details.html
new file mode 100644
index 00000000..972ce919
--- /dev/null
+++ b/src/hi/apps/alert/templates/alert/panes/alarm_details.html
@@ -0,0 +1,14 @@
+<div>
+ <div>
+ Alarmed at: {{ alarm.timestamp }}
+ {{ alarm.source_details_list|length }}
+ </div>
+ <div>
+ {% for source_details in alarm.source_details_list %}
+ {% if alarm.source_details_list|length > 1 %}
+ <h6>Source {{ forloop.counter }} Details</h6>
+ {% endif %}
+ {% include "alert/panes/alarm_source_details.html" %}
+ {% endfor %}
+ </div>
+</div>
diff --git a/src/hi/apps/alert/templates/alert/panes/alarm_source_details.html b/src/hi/apps/alert/templates/alert/panes/alarm_source_details.html
new file mode 100644
index 00000000..4903a1d0
--- /dev/null
+++ b/src/hi/apps/alert/templates/alert/panes/alarm_source_details.html
@@ -0,0 +1,15 @@
+<div>
+ {% if source_details.image_url %}
+ <div>
+ <img class="img-fluid" src="{{ source_details.image_url }}" alt="{{ alarm.title }}">
+ </div>
+ {% endif %}
+ <div>
+ {% for label, value in source_details.detail_attrs.items %}
+ <div class="row">
+ <div class="col-3 text-right">{{ label }}</div>
+ <div class="col-9-">{{ value }}</div>
+ </div>
+ {% endfor %}
+ </div>
+</div>
diff --git a/src/hi/apps/alert/templates/alert/panes/alert_banner.html b/src/hi/apps/alert/templates/alert/panes/alert_banner.html
index e267f352..0b31d1ce 100644
--- a/src/hi/apps/alert/templates/alert/panes/alert_banner.html
+++ b/src/hi/apps/alert/templates/alert/panes/alert_banner.html
@@ -1,5 +1,5 @@
<div id="{{ DIVID.ALERT_BANNER_CONTAINER }}" class="fixed-top"
- style="z-index: 5000; display: none;">
+ style="z-index: 1045; display: none;">
<div id="{{ DIVID.ALERT_BANNER_CONTENT }}"></div>
<button id="hi-alert-banner-toggle" class="btn btn-sm btn-secondary position-absolute"
style="left: 50%; transform: translateX(-50%);"
diff --git a/src/hi/apps/alert/templates/alert/panes/alert_banner_content.html b/src/hi/apps/alert/templates/alert/panes/alert_banner_content.html
index a0fde0ea..650d858f 100644
--- a/src/hi/apps/alert/templates/alert/panes/alert_banner_content.html
+++ b/src/hi/apps/alert/templates/alert/panes/alert_banner_content.html
@@ -18,7 +18,7 @@
<form action="{% url 'alert_acknowledge' alert_id=alert.id %}" method="post"
data-async="true">
{% csrf_token %}
- <input type="submit" class="btn btn-danger" name="action" value="Dismiss">
+ <input type="submit" class="btn btn-secondary" name="action" value="Dismiss">
</form>
</div>
</div>
diff --git a/src/hi/apps/alert/tests/synthetic_data.py b/src/hi/apps/alert/tests/synthetic_data.py
index bc8ff334..d7d6297a 100644
--- a/src/hi/apps/alert/tests/synthetic_data.py
+++ b/src/hi/apps/alert/tests/synthetic_data.py
@@ -2,7 +2,7 @@ from datetime import datetime, timedelta
import random
from typing import List
-from hi.apps.alert.alarm import Alarm
+from hi.apps.alert.alarm import Alarm, AlarmSourceDetails
from hi.apps.alert.alert import Alert
from hi.apps.alert.alert_status import AlertStatusData
from hi.apps.alert.enums import AlarmLevel, AlarmSource, SecurityPosture
@@ -69,7 +69,12 @@ class AlertSyntheticData:
alarm_type = alarm_type,
alarm_level= alarm_level,
title = alarm_title,
- details = f'Details for {alarm_title}. Seed = {seed} ',
+ source_details_list = [
+ AlarmSourceDetails(
+ detail_attrs = { 'Notes': f'Details for {alarm_title}. Seed = {seed} ' },
+ image_url = '/static/img/hi-icon-196x196.png',
+ ),
+ ],
security_posture = security_posture,
alarm_lifetime_secs = alarm_lifetime_secs,
timestamp = alarm_timestamp,
@@ -86,7 +91,12 @@ class AlertSyntheticData:
alarm_type = alarm_type,
alarm_level= alarm_level,
title = alarm_title,
- details = f'Details for {alarm_title}. Seed = {seed} ',
+ source_details_list = [
+ AlarmSourceDetails(
+ detail_attrs = { 'Notes': f'Details for {alarm_title}. Seed = {seed} ' },
+ image_url = '/static/img/hi-icon-196x196.png',
+ ),
+ ],
security_posture = security_posture,
alarm_lifetime_secs = alarm_lifetime_secs,
timestamp = alarm_timestamp,
diff --git a/src/hi/apps/alert/views.py b/src/hi/apps/alert/views.py
index aa641e2b..8747d6dd 100644
--- a/src/hi/apps/alert/views.py
+++ b/src/hi/apps/alert/views.py
@@ -32,5 +32,21 @@ class AlertAcknowledgeView( View ):
class AlertDetailsView( HiModalView ):
- pass
+
+ def get_template_name( self ) -> str:
+ return 'alert/modals/alert_details.html'
+
+ def get( self, request, *args, **kwargs ):
+ alert_id = kwargs.get( 'alert_id' )
+ alert_manager = AlertManager()
+ try:
+ alert = alert_manager.get_alert( alert_id = alert_id )
+ except KeyError:
+ raise Http404( 'Unknown alert.' )
+
+ context = {
+ 'alert': alert,
+ }
+ return self.modal_response( request, context )
+
diff --git a/src/hi/apps/event/transient_models.py b/src/hi/apps/event/transient_models.py
index ef2915e4..0120dad0 100644
--- a/src/hi/apps/event/transient_models.py
+++ b/src/hi/apps/event/transient_models.py
@@ -3,7 +3,7 @@ from datetime import datetime
from typing import List
from hi.apps.alert.enums import AlarmSource
-from hi.apps.alert.alarm import Alarm
+from hi.apps.alert.alarm import Alarm, AlarmSourceDetails
from hi.apps.entity.models import EntityState
from hi.apps.sense.transient_models import SensorResponse
@@ -24,7 +24,7 @@ class EntityStateTransition:
@dataclass
class Event:
- """ This would be more preceisly described as an "Entity State Transition Event" """
+ """ This would be more preceisly described as an "Entity State Change Event" """
event_definition : EventDefinition
sensor_response_list : List[ SensorResponse ]
@@ -40,12 +40,22 @@ class Event:
)
def to_alarm( self, alarm_action : AlarmAction ) -> Alarm:
+
+ source_details_list = list()
+ for sensor_response in self.sensor_response_list:
+ source_details = AlarmSourceDetails(
+ detail_attrs = sensor_response.detail_attrs,
+ image_url = sensor_response.image_url,
+ )
+ source_details_list.append( source_details )
+ continue
+
return Alarm(
alarm_source = AlarmSource.EVENT,
alarm_type = self.event_definition.event_type.label,
alarm_level = alarm_action.alarm_level,
title = self.event_definition.name,
- details = ', '.join([ x.sensor.name for x in self.sensor_response_list ]),
+ source_details_list = source_details_list,
security_posture = alarm_action.security_posture,
alarm_lifetime_secs = alarm_action.alarm_lifetime_secs,
timestamp = self.timestamp,
diff --git a/src/hi/apps/sense/admin.py b/src/hi/apps/sense/admin.py
index 8bd1d035..13390644 100644
--- a/src/hi/apps/sense/admin.py
+++ b/src/hi/apps/sense/admin.py
@@ -40,6 +40,7 @@ class SensorHistoryAdmin(admin.ModelAdmin):
'value',
'response_datetime',
'details',
+ 'image_url',
)
search_fields = ['sensor__name']
diff --git a/src/hi/apps/sense/migrations/0008_sensorhistory_image_url.py b/src/hi/apps/sense/migrations/0008_sensorhistory_image_url.py
new file mode 100644
index 00000000..08370c11
--- /dev/null
+++ b/src/hi/apps/sense/migrations/0008_sensorhistory_image_url.py
@@ -0,0 +1,20 @@
+# Generated by Django 4.2.15 on 2024-12-08 22:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("sense", "0007_alter_sensorhistory_response_datetime"),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name="sensorhistory",
+ name="image_url",
+ field=models.CharField(
+ blank=True, max_length=255, null=True, verbose_name="Image URL"
+ ),
+ ),
+ ]
diff --git a/src/hi/apps/sense/models.py b/src/hi/apps/sense/models.py
index 7c3637a1..4287cb6a 100644
--- a/src/hi/apps/sense/models.py
+++ b/src/hi/apps/sense/models.py
@@ -80,11 +80,15 @@ class SensorHistory(models.Model):
'Details',
blank = True, null = True,
)
+ image_url = models.TextField(
+ 'Image URL',
+ blank = True, null = True,
+ )
response_datetime = models.DateTimeField(
'Timestamp',
db_index = True,
)
-
+
class Meta:
verbose_name = 'Sensor History'
verbose_name_plural = 'Sensor History'
@@ -93,3 +97,9 @@ class SensorHistory(models.Model):
models.Index( fields = [ 'sensor', '-response_datetime'] ),
]
+ @property
+ def detail_attrs(self):
+ if self.details:
+ return json.loads( self.details )
+ return dict()
+
diff --git a/src/hi/apps/sense/transient_models.py b/src/hi/apps/sense/transient_models.py
index f7043380..c63ec1f3 100644
--- a/src/hi/apps/sense/transient_models.py
+++ b/src/hi/apps/sense/transient_models.py
@@ -1,10 +1,9 @@
from dataclasses import dataclass
from datetime import datetime
import json
-from typing import Dict, List
+from typing import Dict
from hi.apps.entity.enums import EntityStateValue
-from hi.apps.entity.models import Entity
from hi.integrations.core.integration_key import IntegrationKey
@@ -16,8 +15,9 @@ class SensorResponse:
integration_key : IntegrationKey
value : str
timestamp : datetime
- sensor : Sensor = None
- details : str = None
+ sensor : Sensor = None
+ detail_attrs : Dict[ str, str ] = None
+ image_url : str = None
def __str__(self):
return json.dumps( self.to_dict() )
@@ -37,7 +37,8 @@ class SensorResponse:
'value': self.value,
'timestamp': self.timestamp.isoformat(),
'sensor_id': self.sensor.id if self.sensor else None,
- 'details': self.details,
+ 'detail_attrs': self.detail_attrs,
+ 'image_url': self.image_url,
}
def to_sensor_history(self):
@@ -45,7 +46,8 @@ class SensorResponse:
sensor = self.sensor,
value = self.value[0:255],
response_datetime = self.timestamp,
- details = self.details,
+ details = json.dumps(self.detail_attrs),
+ image_url = self.image_url,
)
@classmethod
@@ -55,15 +57,17 @@ class SensorResponse:
value = sensor_history.value,
timestamp = sensor_history.response_datetime,
sensor = sensor_history.sensor,
- details = sensor_history.details,
+ detail_attrs = sensor_history.detail_attrs,
+ image_url = sensor_history.image_url,
)
@classmethod
- def from_string( self, sensor_reading_str : str ) -> 'SensorResponse':
- sensor_reading_dict = json.loads( sensor_reading_str )
+ def from_string( self, sensor_response_str : str ) -> 'SensorResponse':
+ sensor_response_dict = json.loads( sensor_response_str )
return SensorResponse(
- integration_key = IntegrationKey.from_string( sensor_reading_dict.get('key') ),
- value = sensor_reading_dict.get('value'),
- timestamp = datetime.fromisoformat( sensor_reading_dict.get('timestamp') ),
- details = sensor_reading_dict.get('details'),
+ integration_key = IntegrationKey.from_string( sensor_response_dict.get('key') ),
+ value = sensor_response_dict.get('value'),
+ timestamp = datetime.fromisoformat( sensor_response_dict.get('timestamp') ),
+ detail_attrs = sensor_response_dict.get('detail_attrs'),
+ image_url = sensor_response_dict.get('image_url'),
)
diff --git a/src/hi/integrations/hass/views.py b/src/hi/integrations/hass/views.py
index 48304dec..c3cde620 100644
--- a/src/hi/integrations/hass/views.py
+++ b/src/hi/integrations/hass/views.py
@@ -15,7 +15,6 @@ from hi.integrations.core.views import IntegrationPageView
from hi.hi_async_view import HiModalView
from .hass_metadata import HassMetaData
-from .hass_manager import HassManager
from .hass_sync import HassSynchronizer
diff --git a/src/hi/integrations/zoneminder/sensor_response_helper.py b/src/hi/integrations/zoneminder/sensor_response_helper.py
index 2fcf1761..05a071a1 100644
--- a/src/hi/integrations/zoneminder/sensor_response_helper.py
+++ b/src/hi/integrations/zoneminder/sensor_response_helper.py
@@ -1,4 +1,5 @@
import json
+from typing import Dict
from .zm_manager import ZoneMinderManager
from .zm_models import ZmEvent, ZmResponseDetails, ZmEventDetails
@@ -7,8 +8,8 @@ from .zm_models import ZmEvent, ZmResponseDetails, ZmEventDetails
class SensorResponseHelper:
@classmethod
- def event_to_details( cls, zm_event : ZmEvent ) -> str:
- event_details = {
+ def event_to_detail_attrs( cls, zm_event : ZmEvent ) -> Dict[ str, str ]:
+ return {
'event_id': zm_event.event_id,
'notes': zm_event.notes,
'duration_secs': zm_event.duration_secs,
@@ -17,7 +18,6 @@ class SensorResponseHelper:
'score': zm_event.score,
'start_datetime': zm_event.start_datetime.isoformat(),
}
- return json.dumps( event_details )
@classmethod
def from_details( cls, details : str ) -> ZmResponseDetails:
diff --git a/src/hi/integrations/zoneminder/templates/zoneminder/modals/zm_event_details.html b/src/hi/integrations/zoneminder/templates/zoneminder/modals/zm_event_details.html
index 78f1480f..93f99767 100644
--- a/src/hi/integrations/zoneminder/templates/zoneminder/modals/zm_event_details.html
+++ b/src/hi/integrations/zoneminder/templates/zoneminder/modals/zm_event_details.html
@@ -31,4 +31,7 @@ ZoneMinder Event Details
Scores: {{ zm_event_details.score.total }} / {{ zm_event_details.score.average }} / {{ zm_event_details.score.max }}
</div>
+
+
+
{% endblock %}
diff --git a/src/hi/integrations/zoneminder/zm_monitor.py b/src/hi/integrations/zoneminder/zm_monitor.py
index 0e482127..209c8a3d 100644
--- a/src/hi/integrations/zoneminder/zm_monitor.py
+++ b/src/hi/integrations/zoneminder/zm_monitor.py
@@ -213,6 +213,7 @@ class ZoneMinderMonitor( PeriodicMonitor ):
return sensor_response_map
def _create_movement_active_sensor_response( self, zm_event : ZmEvent ):
+
return SensorResponse(
integration_key = self._zm_manager._to_integration_key(
prefix = self._zm_manager.MOVEMENT_SENSOR_PREFIX,
@@ -220,7 +221,8 @@ class ZoneMinderMonitor( PeriodicMonitor ):
),
value = str(EntityStateValue.ACTIVE),
timestamp = zm_event.start_datetime,
- details = SensorResponseHelper.event_to_details( zm_event = zm_event ),
+ detail_attrs = SensorResponseHelper.event_to_detail_attrs( zm_event = zm_event ),
+ image_url = self._zm_manager.get_event_video_stream_url( event_id = zm_event.event_id ),
)
def _create_movement_idle_sensor_response( self, zm_event : ZmEvent ):
diff --git a/src/hi/static/css/main.css b/src/hi/static/css/main.css
index c3e5d9d2..bbaea638 100644
--- a/src/hi/static/css/main.css
+++ b/src/hi/static/css/main.css
@@ -187,7 +187,7 @@ a.underline:visited {
left: 50%;
transform: translate(-50%, -50%);
padding: 1rem;
- z-index: 9999;
+ z-index: 1060;
text-align: center;
font-size: 2rem;
font-weight: bold;
diff --git a/src/hi/static/js/antinode.js b/src/hi/static/js/antinode.js
index ca5a62bc..a67c825d 100644
--- a/src/hi/static/js/antinode.js
+++ b/src/hi/static/js/antinode.js
@@ -364,7 +364,7 @@ function getAsyncTarget( anchorNode ) {
function insertLoadingImage() {
// N.B. The negative margins in the css should be half the width of the loading image.
- let htmlString = '<div id="antinode-loader" style="display:none; position: absolute; top: 50%; left: 50%; margin-left: -64px; margin-top: -64px; z-index: 1020;"><img src="/static/img/antinode-loading.gif" alt="Page Loading Interstitial"/></div>';
+ let htmlString = '<div id="antinode-loader" style="display:none; position: absolute; top: 50%; left: 50%; margin-left: -64px; margin-top: -64px; z-index: 1055;"><img src="/static/img/antinode-loading.gif" alt="Page Loading Interstitial"/></div>';
let loadingObj = $.parseHTML(htmlString);
$('body').append( loadingObj );
return;