Skip to content

Home Information - Your home, your data, organized.

Python

Have start of alert data structures and flow. WIP

Anthony Cassandra5d1b3ec46698
diff --git a/src/hi/apps/alert/transient_models.py b/src/hi/apps/alert/alarm.py
similarity index 61%
rename from src/hi/apps/alert/transient_models.py
rename to src/hi/apps/alert/alarm.py
index d1cf6b61..13694a75 100644
--- a/src/hi/apps/alert/transient_models.py
+++ b/src/hi/apps/alert/alarm.py
@@ -1,24 +1,29 @@
from dataclasses import dataclass
from datetime import datetime
-from .enums import AlarmLevel, SecurityPosture
+from .enums import AlarmLevel, AlarmSource, SecurityPosture
@dataclass
class Alarm:
+ alarm_source : AlarmSource
+ alarm_type : str
+ alarm_level : AlarmLevel
title : str
details : str
security_posture : SecurityPosture
- alarm_level : AlarmLevel
alarm_lifetime_secs : int
timestamp : datetime
@property
- def audio_signal_name(self):
+ def audio_signal(self):
# TODO: Currently based only on the alarm level, but eventually
# allow alarm-specific sounds. e.g., tornado siren sound when
# there's a weather alert.
- return str(self.alarm_level.audio_signal)
-
+ return self.alarm_level.audio_signal
+
+ @property
+ def signature(self):
+ return f'{self.alarm_source}.{self.alarm_type}.{self.alarm_level}'
diff --git a/src/hi/apps/alert/alert.py b/src/hi/apps/alert/alert.py
new file mode 100644
index 00000000..958220b7
--- /dev/null
+++ b/src/hi/apps/alert/alert.py
@@ -0,0 +1,66 @@
+from collections import deque
+from datetime import datetime, timedelta
+import uuid
+
+import hi.apps.common.datetimeproxy as datetimeproxy
+
+from .alarm import Alarm
+
+
+class Alert:
+
+ MAX_ALARM_LIST_SIZE = 50
+
+ def __init__( self, first_alarm : Alarm ):
+
+ self._id = uuid.uuid4().hex
+ self._start_datetime = datetimeproxy.now()
+ self._end_datetime = self.startEpochSecs + timedelta( seconds = first_alarm.alarm_lifetime_secs )
+
+ # Prevent unbounded growth and kept in reverse order of arrival, so
+ # most recent alarm is on the left side of list (popleft)
+ #
+ self._first_alarm = first_alarm
+ self._latest_alarms = deque( maxlen = self.MAX_ALARM_LIST_SIZE )
+ self._latest_alarms.appendleft( first_alarm )
+ self._is_acknowledged = False
+ return
+
+ @property
+ def id(self):
+ return self._id
+
+ @property
+ def start_datetime(self) -> datetime:
+ return self._start_datetime
+
+ @property
+ def end_datetime(self) -> datetime:
+ return self._end_datetime
+
+ @property
+ def first_alarm(self) -> Alarm:
+ return self._first_alarm
+
+ @property
+ def is_acknowledged(self) -> bool:
+ return self._is_acknowledged
+
+ def is_matching_alarm( self, alarm : Alarm ) -> bool:
+ return self._first_alarm.sSignature == alarm.signature
+
+ @property
+ def alert_priority(self) -> int:
+ # TODO: Currently just using AlarmLevel priority, but can refine
+ # this to better order alerts with the same alarm priority
+ return self._first_alarm.alarm_level.priority
+
+ def add_alarm( self, alarm : Alarm ):
+ self._end_datetime = datetimeproxy.now() + timedelta( seconds = alarm.alarm_lifetime_secs )
+ self._latest_alarms.appendleft( alarm )
+ return
+
+ def get_latest_alarm(self) -> Alarm:
+ if len(self._latest_alarms) > 0:
+ return self._latest_alarms[0]
+ return None
diff --git a/src/hi/apps/alert/alert_collection.py b/src/hi/apps/alert/alert_collection.py
new file mode 100644
index 00000000..01f7d6e6
--- /dev/null
+++ b/src/hi/apps/alert/alert_collection.py
@@ -0,0 +1,116 @@
+from datetime import datetime
+import logging
+import threading
+
+import hi.apps.common.datetimeproxy as datetimeproxy
+
+from .alarm import Alarm
+from .alert import Alert
+from .enums import AlarmLevel
+
+logger = logging.getLogger(__name__)
+
+
+class AlertCollection:
+
+ MAX_ALERT_LIST_SIZE = 50
+
+ def __init__(self):
+ self._alert_list = list()
+ self._active_alerts_lock = threading.Lock()
+ self._last_changed_datetime = datetimeproxy.now()
+ return
+
+ def __bool__(self):
+ return bool( self._alert_list )
+
+ def __len__(self):
+ return len( self._alert_list )
+
+ def get_most_important_alert( self, since_datetime : datetime = None ):
+ """
+ Returns the active alert that has the highest priority and which was
+ created since the "since_datetime" passed (if any). If there are
+ multiple events of the same priority, then an arbitrary one is
+ returned. Returns None if there are no active alerts in the
+ specified time frame.
+ """
+ try:
+ self._active_alerts_lock.acquire()
+
+ if len(self._alert_list) < 1:
+ return None
+
+ if since_datetime is None:
+ since_datetime = datetimeproxy.min()
+
+ max_alert = None
+ for alert in self._alert_list:
+ if alert.start_datetime <= since_datetime:
+ continue
+ if max_alert is None:
+ max_alert = alert
+ elif alert.alert_priority > max_alert.alert_priority:
+ max_alert = alert
+ continue
+ finally:
+ self._active_alerts_lock.release()
+ return
+
+ def get_most_recent_alarm( self, since_datetime : datetime = None ):
+ """
+ Of all the alarms in all the alerts, return the most recent
+ one that is new than "since_datetime". Original use of this routine
+ was to find a URL to switch to when automatically changing displays
+ based on alarms.
+ """
+ try:
+ self._active_alerts_lock.acquire()
+
+ if len(self._alert_list) < 1:
+ return None
+
+ if since_datetime is None:
+ since_datetime = datetimeproxy.min()
+
+ latest_alarm = None
+ latest_alarm_datetime = datetimeproxy.min()
+ for alert in self._alert_list:
+ alarm = alert.get_latest_alarm()
+ if not alarm:
+ continue
+ if alarm.timestamp <= since_datetime:
+ continue
+ if alarm.timestamp >= latest_alarm_datetime:
+ latest_alarm = alarm
+ latest_alarm_datetime = alarm.timestamp
+ continue
+
+ return latest_alarm
+
+ finally:
+ self._active_alerts_lock.release()
+ return
+
+ def add_alarm( self, alarm : Alarm ):
+ if alarm.alarm_level == AlarmLevel.NONE:
+ raise ValueError( f'Alarm not alert-worthy: {alarm}' )
+ try:
+ self._active_alerts_lock.acquire()
+ for alert in self._alert_list:
+ if not alert.is_matching_alarm( alarm = alarm ):
+ continue
+ alert._add_alarm( alarm = alarm )
+ self._last_changed_datetime = datetimeproxy.now()
+ logger.debug( f'Added to existing alert: alarm={alarm}, alert={alert}' )
+ return
+
+ new_alert = Alert( first_alarm = alarm )
+ self._alert_list.append( new_alert )
+ self._last_changed_datetime = datetimeproxy.now()
+ logger.debug( f'Added new alert: {new_alert}' )
+ return
+
+ finally:
+ self._active_alerts_lock.release()
+ return
diff --git a/src/hi/apps/alert/alert_manager.py b/src/hi/apps/alert/alert_manager.py
index 393a4fdc..6a74de69 100644
--- a/src/hi/apps/alert/alert_manager.py
+++ b/src/hi/apps/alert/alert_manager.py
@@ -1,8 +1,11 @@
+from datetime import datetime
import logging
from hi.apps.common.singleton import Singleton
-from .transient_models import Alarm
+from .alert_collection import AlertCollection
+from .alarm import Alarm
+from .alert_status import AlertStatusData
logger = logging.getLogger(__name__)
@@ -10,10 +13,57 @@ logger = logging.getLogger(__name__)
class AlertManager(Singleton):
def __init_singleton__(self):
+ self._alert_collection = AlertCollection()
return
+ def get_alert_status_data( self, last_alert_status_datetime : datetime ) -> AlertStatusData:
+
+ # Things to check on alert status:
+ #
+ # 1) Has the alert list changed in any way? If so, return new HTML
+ # Note that the alert list could be empty, but still could be
+ # different from last time.
+ #
+ # 2) Has a new alert been added? If so, tell the client so it
+ # can signal the user (audible).
+ #
+ # 3) What is the most critical alert in the list? This is sent
+ # to the client so it can periodically re-notify that there are
+ # unacknowledged events.
+ #
+ # Because the alerts display their age, we always return the html
+ # for the alert list if it is not empty so those ages can refresh
+ # in the view. Also, we return it if it has changed, which include
+ # it having become empty.
+
+ new_alert = self._alert_collection.get_most_important_alert(
+ since_datetime = last_alert_status_datetime,
+ )
+ if new_alert:
+ max_alert = new_alert.audio_signal_name if new_alert else None
+ else:
+ max_alert = self._alert_collection.get_most_important_alert()
+
+ # TODO: Use this latest new alarm for providing auto-switching to
+ # show something related to the latest event, e.g., camera feed.
+ # This would be a suggestion to the console as it would decide
+ # whether to show it based on the console settings and user
+ # interaction context.
+ #
+ latest_new_alarm = self._alert_collection.get_most_recent_alarm(
+ since_datetime = last_alert_status_datetime,
+ )
+
+ return AlertStatusData(
+ alert_list = None,
+ max_audio_signal = max_alert.audio_signal if max_alert else None,
+ new_audio_signal = new_alert.audio_signal if new_alert else None,
+ )
+
async def add_alarm( self, alarm : Alarm ):
- logging.debug( f'Alarm added: {alarm}' )
- logging.error( '\n\n\nIMPLEMENT ME! AlertManager.add_alarm()\n\n' )
+ logging.debug( f'Adding Alarm: {alarm}' )
+ try:
+ self._alert_collection.add_alarm()
+ except ValueError as ve:
+ logging.info( str(ve) )
return
-
diff --git a/src/hi/apps/alert/alert_status.py b/src/hi/apps/alert/alert_status.py
new file mode 100644
index 00000000..01c347ab
--- /dev/null
+++ b/src/hi/apps/alert/alert_status.py
@@ -0,0 +1,35 @@
+from dataclasses import dataclass
+from typing import ClassVar, List
+
+from hi.apps.config.enums import AudioSignal
+
+from .alert import Alert
+
+
+@dataclass
+class AlertStatusData:
+
+ alert_list : List[ Alert ]
+ max_audio_signal : AudioSignal
+ new_audio_signal : AudioSignal # Not seen before (for immediate audio notification)
+
+ NewAudioSignalNameAttr : ClassVar = 'newAudioSignalName'
+ MaxAudioSignalNameAttr : ClassVar = 'maxAudioSignaName'
+ AlarmMessageHtmlAttr : ClassVar = 'alarmMessageHtml'
+
+ def to_dict(self):
+
+
+
+ # TODO: alarm_list to HTML via new template
+
+
+
+ response_dict = dict()
+ if self.max_audio_signal:
+ response_dict[self.MaxAudioSignalNameAttr] = str(self.max_audio_signal)
+ if self.new_audio_signal:
+ response_dict[self.NewAudioSignalNameAttr] = str(self.new_audio_signal)
+ if self.alert_list:
+ response_dict[self.AlarmMessageHtmlAttr] = zzz
+ return response_dict
diff --git a/src/hi/apps/alert/enums.py b/src/hi/apps/alert/enums.py
index d9bbb3e0..d615c020 100644
--- a/src/hi/apps/alert/enums.py
+++ b/src/hi/apps/alert/enums.py
@@ -2,6 +2,11 @@ from hi.apps.common.enums import LabeledEnum
from hi.apps.config.enums import AudioSignal
+class AlarmSource(LabeledEnum):
+
+ EVENT = ( 'Event' , '' )
+
+
class AlarmLevel(LabeledEnum):
NONE = ( 'None' , '' , 0 , None )
diff --git a/src/hi/apps/api/views.py b/src/hi/apps/api/views.py
index 11339822..031ce8ee 100644
--- a/src/hi/apps/api/views.py
+++ b/src/hi/apps/api/views.py
@@ -6,6 +6,7 @@ from django.core.exceptions import BadRequest
from django.http import HttpResponse
from django.views.generic import View
+from hi.apps.alert.alert_manager import AlertManager
import hi.apps.common.datetimeproxy as datetimeproxy
from hi.apps.config.settings_manager import SettingsManager
from hi.apps.monitor.status_display_manager import StatusDisplayManager
@@ -19,16 +20,19 @@ class StatusView( View ):
ServerStartTimestampAttr = 'startTimestamp'
ServerTimestampAttr = 'timestamp'
- LastServerTimestampParam = 'lastTimestamp'
- CssClassUpdateMap = 'cssClassUpdateMap'
+ LastServerTimestampAttr = 'lastTimestamp'
+ AlertStatusDataAttr = 'alertData'
+ CssClassUpdateMapAttr = 'cssClassUpdateMap'
def get( self, request, *args, **kwargs ):
- last_server_timestamp = request.GET.get( self.LastServerTimestampParam )
+ last_server_timestamp = request.GET.get( self.LastServerTimestampAttr )
last_server_datetime = None
if last_server_timestamp:
try:
- last_server_datetime = datetime.fromisoformat( last_server_timestamp.replace("Z", "+00:00") )
+ last_server_datetime = datetime.fromisoformat(
+ last_server_timestamp.replace("Z", "+00:00")
+ )
except (TypeError, ValueError):
msg = f'Missing or invalid date/time format "{last_server_timestamp}".'
logger.warning( msg )
@@ -37,6 +41,9 @@ class StatusView( View ):
server_start_datetime = SettingsManager().get_server_start_datetime()
server_datetime = datetimeproxy.now()
+ alert_status_data = AlertManager().get_alert_status_data(
+ last_alert_status_datetime = last_server_datetime,
+ )
entity_state_status_data_list = StatusDisplayManager().get_all_entity_state_status_data_list()
status_display_data_list = [ StatusDisplayData(x) for x in entity_state_status_data_list ]
@@ -50,7 +57,8 @@ class StatusView( View ):
data = {
self.ServerStartTimestampAttr: server_start_datetime.isoformat(),
self.ServerTimestampAttr: server_datetime.isoformat(),
- self.CssClassUpdateMap: css_class_update_map,
+ self.AlertStatusDataAttr: alert_status_data.to_dict(),
+ self.CssClassUpdateMapAttr: css_class_update_map,
}
return HttpResponse(
json.dumps(data),
diff --git a/src/hi/apps/attribute/templates/attribute/panes/attribute_form_boolean.html b/src/hi/apps/attribute/templates/attribute/panes/attribute_form_boolean.html
index 897d4c2b..14a96183 100644
--- a/src/hi/apps/attribute/templates/attribute/panes/attribute_form_boolean.html
+++ b/src/hi/apps/attribute/templates/attribute/panes/attribute_form_boolean.html
@@ -6,7 +6,7 @@
<input type="checkbox" name="{{ attribute_form.value.html_name }}"
id="{{ attribute_form.value.id_for_label }}"
{% if attribute_form.value.value %}checked="on"{% endif %} >
- <label for="{{ attribute_form.value.id_for_label }}">Add Alarm Events</label>
+ <label for="{{ attribute_form.value.id_for_label }}">{{ attribute_form.name.value }}</label>
</div>
{% if attribute_form.show_as_editable and attribute_form.instance.is_editable and attribute_form.instance.attribute_type.can_delete %}
diff --git a/src/hi/apps/config/enums.py b/src/hi/apps/config/enums.py
index 284d5284..94e01f99 100644
--- a/src/hi/apps/config/enums.py
+++ b/src/hi/apps/config/enums.py
@@ -89,8 +89,18 @@ class SubsystemAttributeType(LabeledEnum):
True,
str( Theme.default() ),
)
+ AWAY_ALERT_EMAILS_ENABLED = (
+ 'Send Email When Away',
+ 'Whether to send emails for critical alerts to when away.',
+ SubsystemType.ALERTS,
+ AttributeValueType.BOOLEAN,
+ '',
+ True,
+ False,
+ False,
+ )
AWAY_ALERT_EMAILS = (
- 'Away Alert Emails',
+ 'Away Alert Addresses',
'Email addresses to send critical alerts to when away.',
SubsystemType.ALERTS,
AttributeValueType.TEXT,
diff --git a/src/hi/apps/event/admin.py b/src/hi/apps/event/admin.py
index c3e471b5..809ce6b1 100644
--- a/src/hi/apps/event/admin.py
+++ b/src/hi/apps/event/admin.py
@@ -28,6 +28,7 @@ class EventDefinitionAdmin(admin.ModelAdmin):
list_display = (
'name',
+ 'event_type_str',
'event_window_secs',
'dedupe_window_secs',
'enabled',
diff --git a/src/hi/apps/event/edit/forms.py b/src/hi/apps/event/edit/forms.py
index 1872b29d..58fe7783 100644
--- a/src/hi/apps/event/edit/forms.py
+++ b/src/hi/apps/event/edit/forms.py
@@ -7,6 +7,7 @@ from hi.apps.control.models import Controller
from hi.apps.common.forms import CustomBaseFormSet
from hi.apps.entity.edit.forms import EntityStateSelectModelFormMixin
from hi.apps.entity.models import EntityState
+from hi.apps.event.enums import EventType
import hi.apps.event.models as models
logger = logging.getLogger(__name__)
@@ -18,10 +19,19 @@ class EventDefinitionForm( forms.ModelForm ):
model = models.EventDefinition
fields = (
'name',
+ 'event_type_str',
'event_window_secs',
'dedupe_window_secs',
'enabled',
)
+
+ event_type_str = forms.ChoiceField(
+ label = 'Event Type',
+ choices = EventType.choices,
+ initial = EventType.default_value(),
+ required = True,
+ widget = forms.Select( attrs = { 'class' : 'custom-select' } ),
+ )
class EventClauseForm( forms.ModelForm, EntityStateSelectModelFormMixin ):
diff --git a/src/hi/apps/event/enums.py b/src/hi/apps/event/enums.py
new file mode 100644
index 00000000..d8d3efe8
--- /dev/null
+++ b/src/hi/apps/event/enums.py
@@ -0,0 +1,10 @@
+from hi.apps.common.enums import LabeledEnum
+
+
+class EventType(LabeledEnum):
+
+ SECURITY = ( 'Security' , '' )
+ MAINTENANCE = ( 'Maintenance' , '' )
+ INFORMATION = ( 'Information' , '' )
+ AUTOMATION = ( 'Automation' , '' )
+
diff --git a/src/hi/apps/event/migrations/0009_eventdefinition_event_type_str_and_more.py b/src/hi/apps/event/migrations/0009_eventdefinition_event_type_str_and_more.py
new file mode 100644
index 00000000..2e99ef14
--- /dev/null
+++ b/src/hi/apps/event/migrations/0009_eventdefinition_event_type_str_and_more.py
@@ -0,0 +1,26 @@
+# Generated by Django 4.2.15 on 2024-12-07 23:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("event", "0008_alter_eventhistory_event_datetime"),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name="eventdefinition",
+ name="event_type_str",
+ field=models.CharField(
+ default="security", max_length=32, verbose_name="Event Type"
+ ),
+ preserve_default=False,
+ ),
+ migrations.AlterField(
+ model_name="eventdefinition",
+ name="dedupe_window_secs",
+ field=models.PositiveIntegerField(verbose_name="Dedupe Window Secs"),
+ ),
+ ]
diff --git a/src/hi/apps/event/models.py b/src/hi/apps/event/models.py
index 2339cfde..cb6dfc17 100644
--- a/src/hi/apps/event/models.py
+++ b/src/hi/apps/event/models.py
@@ -6,6 +6,8 @@ from hi.apps.entity.models import EntityState
from hi.integrations.core.models import IntegrationKeyModel
+from .enums import EventType
+
class EventDefinition( IntegrationKeyModel ):
@@ -13,6 +15,11 @@ class EventDefinition( IntegrationKeyModel ):
'Name',
max_length = 64,
)
+ event_type_str = models.CharField(
+ 'Event Type',
+ max_length = 32,
+ null = False, blank = False,
+ )
# For multi-clause event definitions, the span in which all clauses
# need to satisfied.
@@ -26,7 +33,7 @@ class EventDefinition( IntegrationKeyModel ):
# event would be generated.
#
dedupe_window_secs = models.PositiveIntegerField(
- 'Desupe Window Secs',
+ 'Dedupe Window Secs',
)
enabled = models.BooleanField(
@@ -47,6 +54,15 @@ class EventDefinition( IntegrationKeyModel ):
verbose_name = 'Event Definition'
verbose_name_plural = 'Event Definitions'
+ @property
+ def event_type(self):
+ return EventType.from_name_safe( self.event_type_str )
+
+ @event_type.setter
+ def event_type( self, event_type : EventType ):
+ self.event_type_str = str(event_type)
+ return
+
class EventClause( models.Model ):
diff --git a/src/hi/apps/event/templates/event/edit/panes/event_definition_form.html b/src/hi/apps/event/templates/event/edit/panes/event_definition_form.html
index 000476ca..b0b72d91 100644
--- a/src/hi/apps/event/templates/event/edit/panes/event_definition_form.html
+++ b/src/hi/apps/event/templates/event/edit/panes/event_definition_form.html
@@ -16,6 +16,12 @@
{{ event_definition_form.name.errors }}
</div>
+<div>
+ {{ event_definition_form.event_type_str.label }}
+ {{ event_definition_form.event_type_str }}
+ {{ event_definition_form.event_type_str.errors }}
+</div>
+
<div>
{{ event_definition_form.event_window_secs.label }}
{{ event_definition_form.event_window_secs }}
diff --git a/src/hi/apps/event/templates/event/panes/event_definitions.html b/src/hi/apps/event/templates/event/panes/event_definitions.html
index d02ebbee..088abb22 100644
--- a/src/hi/apps/event/templates/event/panes/event_definitions.html
+++ b/src/hi/apps/event/templates/event/panes/event_definitions.html
@@ -14,7 +14,8 @@
<div class="row">
<div class="col-1 font-weight-bold"></div>
- <div class="col-3 font-weight-bold">Name</div>
+ <div class="col-4 font-weight-bold">Name</div>
+ <div class="col-2 font-weight-bold">Type</div>
<div class="col-2 font-weight-bold">Actions</div>
<div class="col-1 font-weight-bold">Enabled?</div>
<div class="col-1 font-weight-bold"></div>
@@ -29,12 +30,15 @@
EDIT
</a>
</div>
- <div class="col-3">
+ <div class="col-4">
<a href="{% url 'event_definition_edit' id=event_definition.id %}"
data-async="modal" >
{{ event_definition.name }}
</a>
</div>
+ <div class="col-2">
+ {{ event_definition.event_type.label }}
+ </div>
<div class="col-2">
{% if event_definition.control_actions.all|length > 0 %}Control{%endif %}
{% if event_definition.alarm_actions.all|length > 0 %}Alarm{%endif %}
diff --git a/src/hi/apps/event/transient_models.py b/src/hi/apps/event/transient_models.py
index 35dbfcbe..c1b89ca0 100644
--- a/src/hi/apps/event/transient_models.py
+++ b/src/hi/apps/event/transient_models.py
@@ -2,7 +2,8 @@ from dataclasses import dataclass
from datetime import datetime
from typing import List
-from hi.apps.alert.transient_models import Alarm
+from hi.apps.alert.enums import AlarmSource
+from hi.apps.alert.alarm import Alarm
from hi.apps.entity.models import EntityState
from hi.apps.sense.transient_models import SensorResponse
@@ -23,7 +24,9 @@ class EntityStateTransition:
@dataclass
class Event:
- event_definition : EventDefinition
+ """ This would be more preceisly described as an "Entity State Transition Event" """
+
+ event_definition : EventDefinition
sensor_response_list : List[ SensorResponse ]
@property
@@ -38,10 +41,12 @@ class Event:
def to_alarm( self, alarm_action : AlarmAction ) -> Alarm:
return Alarm(
+ alarm_source = AlarmSource.EVENT,
+ alarm_type = str(self.event_definition.event_type),
+ alarm_level = alarm_action.alarm_level,
title = self.event_definition.name,
details = ', '.join([ x.sensor.name for x in self.sensor_response_list ]),
security_posture = alarm_action.security_posture,
- alarm_level = alarm_action.alarm_level,
alarm_lifetime_secs = alarm_action.alarm_lifetime_secs,
timestamp = self.timestamp,
)
diff --git a/src/hi/apps/model_helper.py b/src/hi/apps/model_helper.py
index 5de923f9..26db8215 100644
--- a/src/hi/apps/model_helper.py
+++ b/src/hi/apps/model_helper.py
@@ -11,6 +11,7 @@ from hi.apps.entity.enums import (
TemperatureUnit,
)
from hi.apps.entity.models import Entity, EntityState
+from hi.apps.event.enums import EventType
from hi.apps.event.models import AlarmAction, EventClause, EventDefinition
from hi.apps.sense.enums import SensorType
from hi.apps.sense.models import Sensor
@@ -363,6 +364,7 @@ class HiModelHelper:
return cls.create_simple_alarm_event_definition(
name = name,
+ event_type = EventType.INFORMATION,
entity_state = entity_state,
value = EntityStateValue.DISCONNECTED,
posture_to_level = {
@@ -385,6 +387,7 @@ class HiModelHelper:
return cls.create_simple_alarm_event_definition(
name = name,
+ event_type = EventType.SECURITY,
entity_state = entity_state,
value = EntityStateValue.OPEN,
posture_to_level = {
@@ -407,6 +410,7 @@ class HiModelHelper:
return cls.create_simple_alarm_event_definition(
name = name,
+ event_type = EventType.SECURITY,
entity_state = entity_state,
value = EntityStateValue.ACTIVE,
posture_to_level = {
@@ -429,6 +433,7 @@ class HiModelHelper:
return cls.create_simple_alarm_event_definition(
name = name,
+ event_type = EventType.MAINTENANCE,
entity_state = entity_state,
value = EntityStateValue.LOW,
posture_to_level = {
@@ -446,6 +451,7 @@ class HiModelHelper:
def create_simple_alarm_event_definition(
cls,
name : str,
+ event_type : EventType,
entity_state : EntityState,
value : str,
posture_to_level : Dict[ SecurityPosture, AlarmLevel ],
@@ -456,6 +462,7 @@ class HiModelHelper:
event_definition = EventDefinition(
name = name,
+ event_type_str = str(event_type),
event_window_secs = event_window_secs,
dedupe_window_secs = dedupe_window_secs,
enabled = True,
diff --git a/src/hi/static/css/main.css b/src/hi/static/css/main.css
index e9389c90..b4d9bd57 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: 999;
+ z-index: 9999;
text-align: center;
font-size: 2rem;
font-weight: bold;
diff --git a/src/hi/static/js/audio.js b/src/hi/static/js/audio.js
index d42e7c6c..812c2856 100644
--- a/src/hi/static/js/audio.js
+++ b/src/hi/static/js/audio.js
@@ -12,6 +12,9 @@
startAudibleSignal: function( signalName ) {
_startAudibleSignal( signalName );
},
+ setMaxSignalName: function( signalName ) {
+ return _setMaxSignalName( signalName );
+ }
};
window.Hi.audio = HiAudio;
@@ -68,6 +71,11 @@
let gAudibleSignalTimer = null;
let gActiveAudibleSignalName = null;
+ function _setMaxSignalName( signalName ) {
+ gCurrentMaxSignalName = signalName;
+ return true;
+ }
+
function setAudibleSignalTimer( ) {
clearAudibleSignalTimer();
gAudibleSignalTimer = setTimeout( endAudibleSignal, AudibleSignalDurationMs );
diff --git a/src/hi/static/js/status.js b/src/hi/static/js/status.js
index c33e4a6f..5b0951a4 100644
--- a/src/hi/static/js/status.js
+++ b/src/hi/static/js/status.js
@@ -27,8 +27,14 @@
const ServerPollingUrl = '/api/status';
const ServerStartTimestampAttr = 'startTimestamp';
const ServerTimestampAttr = 'timestamp';
- const LastServerTimestampParam = 'lastTimestamp';
- const CssClassUpdateMap = 'cssClassUpdateMap';
+ const LastServerTimestampAttr = 'lastTimestamp';
+ const CssClassUpdateMapAttr = 'cssClassUpdateMap';
+ const AlertStatusDataAttr = 'alertData';
+
+ const AlertMessageSelector = '#hi-alert-message';
+ const MaxAudioSignalNameAttr = 'maxAudioSignaName';
+ const NewAudioSignalNameAttr = 'newAudioSignalName';
+ const AlarmMessageHtmlAttr = 'alarmMessageHtml';
let gServerPollingTimer = null;
let gCssClassElementCache = {};
@@ -58,19 +64,11 @@
function fetchServerResponse() {
if ( Hi.DEBUG ) { console.log( "Polling server..." ); }
clearServerPollingTimer();
-
-
-
-
- console.log( `AUDIO ENABLED = ${Hi.settings.isAudioEnabled()}` );
-
-
-
let url = ServerPollingUrl;
if ( gLastServerDate ) {
const lastTimestampString = encodeURIComponent( gLastServerDate.toISOString() );
- url += `?${LastServerTimestampParam}=${lastTimestampString}`;
+ url += `?${LastServerTimestampAttr}=${lastTimestampString}`;
}
$.ajaxSuppressLoader = true;
@@ -84,6 +82,7 @@
success: function( data, status, xhr ) {
try {
Hi.watchdog.ok( ServerPollingWatchdogType );
+ clearServerErrorIfNeeded();
gLastServerPollSuccessTime = (new Date()).getTime();
handleServerResponse( data, status, xhr );
@@ -116,9 +115,11 @@
if ( ServerTimestampAttr in respObj ) {
gLastServerDate = new Date( respObj[ServerTimestampAttr] );
}
-
- if ( CssClassUpdateMap in respObj ) {
- handleCssClassUpdates( respObj[CssClassUpdateMap] );
+ if ( AlertStatusDataAttr in respObj ) {
+ handleAlertStatusData( respObj[AlertStatusDataAttr] );
+ }
+ if ( CssClassUpdateMapAttr in respObj ) {
+ handleCssClassUpdates( respObj[CssClassUpdateMapAttr] );
}
}
@@ -137,6 +138,31 @@
}
}
+ function handleAlertStatusData( alertStatusData ) {
+ if ( ! alertStatusData ) {
+ return;
+ }
+
+ if (( MaxAudioSignalNameAttr in alertStatusData )
+ && ( alertStatusData[MaxAudioSignalNameAttr] )) {
+ Hi.audio.setMaxSignalName( alertStatusData[MaxAudioSignalNameAttr] );
+ }
+
+ if (( NewAudioSignalNameAttr in alertStatusData )
+ && ( alertStatusData[NewAudioSignalNameAttr] )) {
+ Hi.audio.startAudibleSignal( alertStatusData[NewAudioSignalNameAttr] );
+ }
+
+ console.log( 'Alarm Message', alertStatusData );
+
+ if (( AlarmMessageHtmlAttr in alertStatusData )
+ && alertStatusData[AlarmMessageHtmlAttr] ) {
+ $(AlertMessageSelector).html( alertStatusData[AlarmMessageHtmlAttr] ).show();
+ } else {
+ $(AlertMessageSelector).empty().hide();
+ }
+ }
+
function handleCssClassUpdates( updateMap ) {
for ( let cssClass in updateMap ) {
@@ -218,7 +244,7 @@
Hi.sound.startAudibleSignal( Hi.sound.WARNING_SIGNAL_NAME );
}
- function clearServerError() {
+ function clearServerErrorIfNeeded() {
if ( ! gIsServerErrorShowing ) {
return;
}
diff --git a/src/hi/templates/pages/base.html b/src/hi/templates/pages/base.html
index d13c425b..1900a19f 100644
--- a/src/hi/templates/pages/base.html
+++ b/src/hi/templates/pages/base.html
@@ -23,7 +23,11 @@
const gHiViewMode = "{{ request.view_parameters.view_mode }}";
</script>
{% javascript 'js_before_content' %}
-
+
+ <div id="hi-alert-message"
+ class="fixed-top bg-danger text-white text-center py-2"
+ style="z-index: 5000; display: none;"></div>
+
{% block content %}{% endblock %}
{% include "config/panes/base_page_settings.html" %}